docsify-plugin-github-footer

Docsify Plugins

GitHub Footer

by simochee

Useful GitHub Pages links footer for Docsify.

📀 Installation

Insert a script tag to load the plugin script file after loading the Docsify script.

<script>
  window.$docsify = {};
</script>
<script src="//cdn.jsdelivr.net/npm/docsify@v4/lib/docsify.min.js"></script>
<script src="//cdn.jsdelivr.net/npm/docsify-plugin-github-footer/lib/docsify-plugin-github-footer.min.js"></script>

🔰 Usage

Configure the plugin in the Docsify configuration.

<script>
  window.$docsify = {
    githubFooter: {
      // required: production branch
      ref: 'develop',
      // optional: inherit from $docsify.repo
      repo: 'simochee/docs-repo',
      // optional: base directory of the repo
      dir: 'docs',
    }
  };
</script>

Customize footer style

<style>
.docsify-github-footer {
  /* override style */
}
</style>

💻 Development

1. Clone this repository
2. Enable Corepack using corepack enable
3. Install dependencies using pnpm install
4. Run watch mode using pnpm run watch
5. Start server using Live Server
6. Insert a script tag to load the plugin script file after loading the Docsify script.

<script src="http://localhost:5500"></script>

🛡️ License

MIT