1.1.1 ā¢ Published 4 years ago
@markbattistella/mbdocsify-sidebarfooter v1.1.1
Getting started
Installation
- Configure the
docsify-autoFooter
:
<script>
window.$docsify = {
autoFooter: {
name: '',
url: '',
copyYear: '',
policy: '',
terms: ''
}
};
</script>
- Insert script into docsify document:
<script src="docsify-sidebarFooter.js"></script>
If you are using the Privacy Policy and Terms of Service links, then add the two files to the root (next to
index.html
)| docs |-- _privacy.md |-- _terms.md
Add the
<div id="mb-footer"></div>
to the bottom of the_sidebar.md
. I guess you can add this anywhere, but it's designed for the sidebar.Find a couple of online generators to help fill in the data :smiley:
Configuration
There are some options available for the docsify-autoHeaders
:
setting | options |
---|---|
name | your name or your company - whoever is the owner |
url | the url you want the name to link to (optional) |
copyYear | the first year of copyright. leave blank for current year |
policy | do you have a Privacy Policy page |
terms | do you have a Terms of Service page |
Usage
Fill in the data within the configuration, and it will all auto populate.
Example
Contributing
Clone the repo:
git clone https://github.com/markbattistella/docsify-sidebarFooter.git
Create your feature branch:
git checkout -b my-feature
Commit your changes:
git commit -am 'Add some feature'
Push to the branch:
git push origin my-new-feature
Submit a
pull
request
Author: @me
- š Iām currently working on some secret projects
- š± Iām learning
- š« Reach me: Twitter š¦
1.1.1
4 years ago