1.1.1 ā€¢ Published 4 years ago

@markbattistella/mbdocsify-sidebarfooter v1.1.1

Weekly downloads
-
License
MIT
Repository
github
Last release
4 years ago

Getting started

Installation

  1. Configure the docsify-autoFooter:
<script>
window.$docsify = {
    autoFooter: {
		name:		'',
		url:		'',
		copyYear:	'',
		policy:		'',
		terms:		''
	}
};
</script>
  1. Insert script into docsify document:
<script src="docsify-sidebarFooter.js"></script>
  1. 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
  2. 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.

  3. Find a couple of online generators to help fill in the data :smiley:

Configuration

There are some options available for the docsify-autoHeaders:

settingoptions
nameyour name or your company - whoever is the owner
urlthe url you want the name to link to (optional)
copyYearthe first year of copyright. leave blank for current year
policydo you have a Privacy Policy page
termsdo you have a Terms of Service page

Usage

Fill in the data within the configuration, and it will all auto populate.

Example

Example output

Contributing

  1. Clone the repo:

    git clone https://github.com/markbattistella/docsify-sidebarFooter.git
  2. Create your feature branch:

    git checkout -b my-feature
  3. Commit your changes:

    git commit -am 'Add some feature'
  4. Push to the branch:

    git push origin my-new-feature
  5. Submit a pull request


Author: @me

  • šŸ”­ Iā€™m currently working on some secret projects
  • šŸŒ± Iā€™m learning
  • šŸ“« Reach me: Twitter šŸ¦