Skip to content

Commit

Permalink
chore(docs): updated the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
anikethsaha authored Feb 11, 2020
1 parent a5ec031 commit affdd32
Showing 1 changed file with 56 additions and 2 deletions.
58 changes: 56 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/[email protected]/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

```html
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/index.js"></script>
```

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

<p align="center">

<img alt="ss" src="https://imgur.com/JAr22Ik.png" width="400px" />
<br/>
<img alt="ss" src="https://imgur.com/FGljyYR.png" width="400px" />

</p>


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

0 comments on commit affdd32

Please sign in to comment.