docsify-changelog-plugin

docsify-changelog-plugin

This is a docsify plugin to render changelog from given path

Installation

Add the following stylesheet along with your other stylesheets

<link
  rel="stylesheet"
  href="//cdn.jsdelivr.net/npm/docsify-changelog-plugin@latest/dist/style.css"
/>
<link
  rel="stylesheet"
  href="//maxcdn.bootstrapcdn.com/font-awesome/4.5.0/css/font-awesome.min.css"
/>

And add the following script

<script src="https://cdn.jsdelivr.net/npm/docsify-changelog-plugin@latest/dist/index.js"></script>

Configure

In your docsify config object add the following

window.$docsify = {
...
changelog : 'CHANGELOG.md' // path of your changelog, it can be remote as well
...
}

And add the following custom nav bar

<nav></nav>

or you can use the loadNavbar option but make sure you have the _navbar.md or custom nav-bar source to render the changelog.

Refer this for more info about navbar

Thanks it, Now enjoy :tada: your changelog integration with docsify

Screen Shot

Contribution Guide

• Clone the repo
• start editing on src/index.js and src/style.styl
• The build step using
  • the styl -> css using styl CLI
  • Optimize the generated style using cssnano and postcss
  • Build the javascript using rollup
  • optimize it using rollup-plugin-terser
  • styling rule using standard

Faq

Is it responsive? Not yet! soon, I will add the styles to make it responsive

Will it break mergeNavbar options? May be

Can I change the style of the button and the panel? Not yet !, but soon it will be possible using css variable