diff --git a/README.md b/README.md index 4758435..421b4f1 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,68 @@ This is a docsify plugin to render changelog from given path [![JavaScript Style Guide](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard) - +[![](https://data.jsdelivr.com/v1/package/npm/docsify-changelog-plugin/badge)](https://www.jsdelivr.com/package/npm/docsify-changelog-plugin) ## Installation +Add the following stylesheet along with your other stylesheets + +```html + + +``` + +And add the following script + +```html + +``` + ## Configure -## Usage +In your docsify config object add the following + +```js +window.$docsify = { +... +changelog : 'CHANGELOG.md' // path of your changelog, it can be remote as well +... +} +``` + +### Thanks it, Now enjoy :tada: your changelog integration with docsify + +## Screen Shot + +

+ +ss +
+ss + +

+ ## 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