Docsify Plugin Footer

A simple plugin to add page footer to docsify


📥 Download

- Locally

``bash
npm install @sujaykumarh/docsify-plugin-footer
`
- CDN

`html



`

🧰 Configuration

Available options

`js
window.$docsify.customPageFooter = {
debug: false, // for debugging

showPoweredBy: true, // should show powered by docsify at right
copyrightYear: '', // show copyright year, default current year.
showCopyright: true, // set to false to hide default copyright
copyright: undefined, // set this to html string to use custom copyrihgt section
copyrightOwnerName: '', // copyright owner name
copyrightOwnerLink: undefined, // copyright owner link if any
copyrightExtra: undefined, // any exta text to show below copyright owner section

useLocalStorage: true, // build and store footer in localstorage for quick access
}
`

generates footer

`

| content here
| ....
sidebar | ....
|
|
| ___________________________________________________________________
|
| copyright (c) 2021 copyrightOwner. Powered by docsify.
| [---copyrightExtra---]

`

Example:

`html

`

Colors

set a link colors set --primary & --primary-dark in :root

* --primary is used default link color

* --primary-dark is used when link:hover

Example:

`css
...


:root {
--primary: #0f5d9c;
--pirmary-dark: #0a4677;
}


...
`

🛠️ Development

Clone

`bash
git clone https://github.com/Sujaykumarh/docsify-plugin-footer.git
`

install resources

`bash
npm install
`

minify src/plugin.js and src/plugin.css generate minified files in dist folder

`bash
npm run minify # generate minified resources in ./dist

npm run minify:css # generate minified css resources in ./dist
npm run minify:js # generate minified js resources in ./dist
`

📄 License

Copyright (c) 2021 Sujay H Licensed under Apache License v2.0` read LICENSE