docsify-footer-enh

A simple Footer plugin for Docsify

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
docsify-footer-enh
0.0.98 months ago4 years agoMinified + gzip package size for docsify-footer-enh in KB

Readme

docsify-footer
Footer Enhancement plugin for Docsify, based on Docsify example.

Install

  1. Then insert script plugin into Docsify document (index.html)

<script src="//unpkg.com/docsify-footer-enh/dist/docsify-footer-enh.min.js"></script>

  1. Add configuration

<script>
  window.$docsify = {
    footer: {
      copy: '<span>Acme © 2023</span>',
      auth: 'by Me',
      pre: '<hr/>',
      style: 'text-align: right;',
      class: 'className',
    },
  };
</script>

| Config Option | Description | | :------------ | :------------------------ | | copy | Copyright text to display | | auth | Author text | | style | Footer CSS inline style | | class | Footer Classes to include | | pre | Html pre footer text |

Example

  1. Run npm run build
  2. Run npm run example
  3. Go to http://localhost:3000/()

License

Apache License

TODO

  • Waiting for recommendations.