update main markdown files
This commit is contained in:
Johannes Rappen
parent
6eada5a2f7
commit
0b1fc2343f
3 changed files with 314 additions and 190 deletions
109
CHANGELOG.md
109
CHANGELOG.md
|
|
@ -1,86 +1,75 @@
|
||||||
|
# 3.4.0 / 2017-03-09
|
||||||
|
|
||||||
3.4.0 / 2017-03-09
|
* feat(zoom-image): add plugin
|
||||||
==================
|
|
||||||
|
|
||||||
* feat(zoom-image): add plugin
|
# 3.3.0 / 2017-03-07
|
||||||
|
|
||||||
3.3.0 / 2017-03-07
|
* add front-matter plugin
|
||||||
==================
|
* add external-script plugin
|
||||||
|
* Fix nav showing while loading ([#112](https://github.com/QingWei-Li/docsify/issues/112))
|
||||||
|
* Fix a typo ([#111](https://github.com/QingWei-Li/docsify/issues/111))
|
||||||
|
* Update changelog
|
||||||
|
|
||||||
* add front-matter plugin
|
# 3.2.0 / 2017-02-28
|
||||||
* add external-script plugin
|
|
||||||
* Fix nav showing while loading (#112)
|
|
||||||
* Fix a typo (#111)
|
|
||||||
* Update changelog
|
|
||||||
|
|
||||||
3.2.0 / 2017-02-28
|
* fix(render): Toc rendering error, fixed [#106](https://github.com/QingWei-Li/docsify/issues/106)
|
||||||
==================
|
* feat(search): Localization for no data tip, close [#103](https://github.com/QingWei-Li/docsify/issues/103)
|
||||||
|
* fix(fetch): load sidebar and navbar for parent path, fixed [#100](https://github.com/QingWei-Li/docsify/issues/100)
|
||||||
|
* feat(render) nameLink for each route, fixed [#99](https://github.com/QingWei-Li/docsify/issues/99)
|
||||||
|
|
||||||
* fix(render): Toc rendering error, fixed [#106](https://github.com/QingWei-Li/docsify/issues/106)
|
# 3.1.2 / 2017-02-27
|
||||||
* feat(search): Localization for no data tip, close [#103](https://github.com/QingWei-Li/docsify/issues/103)
|
|
||||||
* fix(fetch): load sidebar and navbar for parent path, fixed [#100](https://github.com/QingWei-Li/docsify/issues/100)
|
|
||||||
* feat(render) nameLink for each route, fixed [#99](https://github.com/QingWei-Li/docsify/issues/99)
|
|
||||||
|
|
||||||
3.1.2 / 2017-02-27
|
* fix(search): dont search nameLink, fixed [#102](https://github.com/QingWei-Li/docsify/issues/102)
|
||||||
==================
|
|
||||||
|
|
||||||
* fix(search): dont search nameLink, fixed [#102](https://github.com/QingWei-Li/docsify/issues/102)
|
# 3.1.1 / 2017-02-24
|
||||||
|
|
||||||
3.1.1 / 2017-02-24
|
* fix(search): dont search nameLink, fixed [#102](https://github.com/QingWei-Li/docsify/issues/102)
|
||||||
==================
|
* fix(render): custom cover background image
|
||||||
|
* fix(tpl): extra character, fixed [#101](https://github.com/QingWei-Li/docsify/issues/101)
|
||||||
|
|
||||||
* fix(search): dont search nameLink, fixed [#102](https://github.com/QingWei-Li/docsify/issues/102)
|
# 3.1.0 / 2017-02-22
|
||||||
* fix(render): custom cover background image
|
|
||||||
* fix(tpl): extra character, fixed [#101](https://github.com/QingWei-Li/docsify/issues/101)
|
|
||||||
|
|
||||||
3.1.0 / 2017-02-22
|
* fix(search): incorrect anchor link, fixed [#90](https://github.com/QingWei-Li/docsify/issues/90)
|
||||||
==================
|
* feat(emoji): add emoji plugin
|
||||||
|
|
||||||
* fix(search): incorrect anchor link, fixed [#90](https://github.com/QingWei-Li/docsify/issues/90)
|
# 3.0.5 / 2017-02-21
|
||||||
* feat(emoji): add emoji plugin
|
|
||||||
|
|
||||||
3.0.5 / 2017-02-21
|
* feat(pwa): add sw.js
|
||||||
==================
|
* fix(layout.css): loading style
|
||||||
|
* fix(event): highlight sidebar when clicked, fixed [#86](https://github.com/QingWei-Li/docsify/issues/86)
|
||||||
|
* fix(gen-tree): cache toc list, fixed [#88](https://github.com/QingWei-Li/docsify/issues/88)
|
||||||
|
|
||||||
* feat(pwa): add sw.js
|
# 3.0.4 / 2017-02-20
|
||||||
* fix(layout.css): loading style
|
|
||||||
* fix(event): highlight sidebar when clicked, fixed [#86](https://github.com/QingWei-Li/docsify/issues/86)
|
|
||||||
* fix(gen-tree): cache toc list, fixed [#88](https://github.com/QingWei-Li/docsify/issues/88)
|
|
||||||
|
|
||||||
3.0.4 / 2017-02-20
|
* fix(render): execute script
|
||||||
==================
|
* fix(render): disable rendering sub list when loadSidebar is false
|
||||||
|
|
||||||
* fix(render): execute script
|
# 3.0.3 / 2017-02-19
|
||||||
* fix(render): disable rendering sub list when loadSidebar is false
|
|
||||||
|
|
||||||
3.0.3 / 2017-02-19
|
* fixed look of links in blockquote
|
||||||
==================
|
* fix(scroll) highlight bug
|
||||||
|
|
||||||
* fixed look of links in blockquote
|
# 3.0.2 / 2017-02-19
|
||||||
* fix(scroll) highlight bug
|
|
||||||
|
|
||||||
3.0.2 / 2017-02-19
|
* fix(search): add lazy input
|
||||||
==================
|
* fix(compiler): link
|
||||||
|
|
||||||
* fix(search): add lazy input
|
# 3.0.1 / 2017-02-19
|
||||||
* fix(compiler): link
|
|
||||||
|
|
||||||
3.0.1 / 2017-02-19
|
* fix(route): empty alias
|
||||||
==================
|
|
||||||
|
|
||||||
* fix(route): empty alias
|
# 3.0.0 / 2017-02-19
|
||||||
|
|
||||||
3.0.0 / 2017-02-19
|
|
||||||
==================
|
|
||||||
|
|
||||||
#### Breaking change
|
#### Breaking change
|
||||||
- Not support IE9
|
|
||||||
- The route becomes: `/#/page?id=slug`. The previous route will be redirected
|
* Not support IE9
|
||||||
|
* The route becomes: `/#/page?id=slug`. The previous route will be redirected
|
||||||
|
|
||||||
#### Features
|
#### Features
|
||||||
- Faster rendering
|
|
||||||
- Clearer source code
|
* Faster rendering
|
||||||
- More powerful API
|
* Clearer source code
|
||||||
- Auto header for each page [#78](https://github.com/QingWei-Li/docsify/issues/78)
|
* More powerful API
|
||||||
- Localization for search plugin [#80](https://github.com/QingWei-Li/docsify/issues/80)
|
* Auto header for each page [#78](https://github.com/QingWei-Li/docsify/issues/78)
|
||||||
- Execute the script in markdown (see `executeScript`)
|
* Localization for search plugin [#80](https://github.com/QingWei-Li/docsify/issues/80)
|
||||||
|
* Execute the script in markdown (see `executeScript`)
|
||||||
|
|
|
||||||
368
HISTORY.md
368
HISTORY.md
|
|
@ -3,22 +3,24 @@
|
||||||
> 2017-02-15
|
> 2017-02-15
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
* fix emoji replacing error (#76)
|
|
||||||
|
* fix emoji replacing error ([#76](https://github.com/QingWei-Li/docsify/issues/76))
|
||||||
|
|
||||||
### 2.4.2
|
### 2.4.2
|
||||||
|
|
||||||
> 2017-02-14
|
> 2017-02-14
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- fix(index): load file path error
|
|
||||||
|
|
||||||
|
* fix(index): load file path error
|
||||||
|
|
||||||
### 2.4.1
|
### 2.4.1
|
||||||
|
|
||||||
> 2017-02-13
|
> 2017-02-13
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- fix(index): cover page
|
|
||||||
|
* fix(index): cover page
|
||||||
|
|
||||||
### 2.4.0
|
### 2.4.0
|
||||||
|
|
||||||
|
|
@ -26,8 +28,7 @@
|
||||||
|
|
||||||
#### Features
|
#### Features
|
||||||
|
|
||||||
- feat(hook): add `doneEach`
|
* feat(hook): add `doneEach`
|
||||||
|
|
||||||
|
|
||||||
### 2.3.0
|
### 2.3.0
|
||||||
|
|
||||||
|
|
@ -35,352 +36,477 @@
|
||||||
|
|
||||||
#### Features
|
#### Features
|
||||||
|
|
||||||
- feat(src): add alias feature
|
* feat(src): add alias feature
|
||||||
- docs: update all documents
|
* docs: update all documents
|
||||||
- feat(src): dynamic title
|
* feat(src): dynamic title
|
||||||
- feat(hook): support custom plugin
|
* feat(hook): support custom plugin
|
||||||
- feat(themes): add dark theme
|
* feat(themes): add dark theme
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- fix(event): `auto2top` has no effect on a FF mobile browser, fixed #67
|
|
||||||
- fix: sidebar style
|
* fix(event): `auto2top` has no effect on a FF mobile browser, fixed #67
|
||||||
- fix(render): fix render link
|
* fix: sidebar style
|
||||||
|
* fix(render): fix render link
|
||||||
|
|
||||||
### 2.2.1
|
### 2.2.1
|
||||||
|
|
||||||
> 2017-02-11
|
> 2017-02-11
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- fix(search): crash when not content, fixed #68
|
|
||||||
- fix(event): scroll active sidebar
|
* fix(search): crash when not content, fixed [#68](https://github.com/QingWei-Li/docsify/issues/68)
|
||||||
- fix(search): not work in mobile
|
* fix(event): scroll active sidebar
|
||||||
|
* fix(search): not work in mobile
|
||||||
|
|
||||||
### 2.2.0
|
### 2.2.0
|
||||||
|
|
||||||
#### Features
|
#### Features
|
||||||
- Add `Google Analytics` plugin.
|
|
||||||
```html
|
* Add `Google Analytics` plugin.
|
||||||
<script src="//unpkg.com/docsify" data-ga="UA-XXXXX-Y"></script>
|
```html
|
||||||
<script src="//unpkg.com/docsify/lib/plugins/ga.js"></script>
|
<script src="//unpkg.com/docsify" data-ga="UA-XXXXX-Y"></script>
|
||||||
```
|
<script src="//unpkg.com/docsify/lib/plugins/ga.js"></script>
|
||||||
|
```
|
||||||
|
|
||||||
### 2.1.0
|
### 2.1.0
|
||||||
|
|
||||||
#### Features
|
#### Features
|
||||||
- Add search plugin
|
|
||||||
```html
|
* Add search plugin
|
||||||
<script src="//unpkg.com/docsify"></script>
|
```html
|
||||||
<script src="//unpkg.com/docsify/lib/plugins/search.js"></script>
|
<script src="//unpkg.com/docsify"></script>
|
||||||
```
|
<script src="//unpkg.com/docsify/lib/plugins/search.js"></script>
|
||||||
|
```
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- fix sidebar style
|
|
||||||
|
* fix sidebar style
|
||||||
|
|
||||||
### 2.0.3
|
### 2.0.3
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- fix: rendering emojis
|
|
||||||
- fix: css var polyfill
|
* fix: rendering emojis
|
||||||
|
* fix: css var polyfill
|
||||||
|
|
||||||
### 2.0.2
|
### 2.0.2
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- fix button style in cover page.
|
|
||||||
|
* fix button style in cover page.
|
||||||
|
|
||||||
### 2.0.1
|
### 2.0.1
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- border style.
|
|
||||||
|
* border style.
|
||||||
|
|
||||||
### 2.0.0
|
### 2.0.0
|
||||||
|
|
||||||
#### Features
|
#### Features
|
||||||
- Customize the theme color
|
|
||||||
|
* Customize the theme color
|
||||||
|
|
||||||
#### Break change
|
#### Break change
|
||||||
- Remove `data-router`, `data-sidebar`, `data-sidebar-toggle` APIs
|
|
||||||
|
* Remove `data-router`, `data-sidebar`, `data-sidebar-toggle` APIs
|
||||||
|
|
||||||
|
|
||||||
### 1.10.5
|
### 1.10.5
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- fix initialize the Vue instance
|
|
||||||
|
* fix initialize the Vue instance
|
||||||
|
|
||||||
### 1.10.4
|
### 1.10.4
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- fix execute script
|
|
||||||
|
* fix execute script
|
||||||
|
|
||||||
### 1.10.3
|
### 1.10.3
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- compatible vuep QingWei-Li/vuep/issues/2
|
|
||||||
- fix sidebar scroll, fixed #63
|
* compatible vuep ([#2](https://github.com/QingWei-Li/vuep/issues/2))
|
||||||
|
* fix sidebar scroll, fixed [#63](https://github.com/QingWei-Li/docsify/issues/63)
|
||||||
|
|
||||||
### 1.10.2
|
### 1.10.2
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Fix render emojis again
|
|
||||||
|
* Fix render emojis again
|
||||||
|
|
||||||
### 1.10.1
|
### 1.10.1
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Fix render emojis
|
|
||||||
|
* Fix render emojis
|
||||||
|
|
||||||
### 1.10.0
|
### 1.10.0
|
||||||
|
|
||||||
#### Features
|
#### Features
|
||||||
- Support emoji :laughing:
|
|
||||||
|
* Support emoji :laughing:
|
||||||
|
|
||||||
### 1.9.0
|
### 1.9.0
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Destroys the vue instance when the route is changed
|
|
||||||
|
* Destroys the vue instance when the route is changed
|
||||||
|
|
||||||
#### Features
|
#### Features
|
||||||
- Add `!>` and `?>` doc helper.
|
|
||||||
|
* Add `!>` and `?>` doc helper.
|
||||||
|
|
||||||
#### Break change
|
#### Break change
|
||||||
- Remove `!` doc helper.
|
|
||||||
|
* Remove `!` doc helper.
|
||||||
|
|
||||||
### 1.8.0
|
### 1.8.0
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Using `v-pre` skip compilation.
|
|
||||||
|
* Using `v-pre` skip compilation.
|
||||||
|
|
||||||
### Features
|
### Features
|
||||||
- Execute script when vue exists.
|
|
||||||
|
* Execute script when vue exists.
|
||||||
|
|
||||||
### 1.7.4
|
### 1.7.4
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Fix bugs caused by the previous version
|
|
||||||
|
* Fix bugs caused by the previous version
|
||||||
|
|
||||||
### 1.7.3
|
### 1.7.3
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Add `hr` style
|
|
||||||
- Fixed option is an empty string
|
* Add `hr` style
|
||||||
|
* Fixed option is an empty string
|
||||||
|
|
||||||
### 1.7.2
|
### 1.7.2
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Fix sidebar click event in mobile browser.
|
|
||||||
|
* Fix sidebar click event in mobile browser.
|
||||||
|
|
||||||
### 1.7.1
|
### 1.7.1
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Fix sidebar style in mobile browser.
|
|
||||||
|
* Fix sidebar style in mobile browser.
|
||||||
|
|
||||||
### 1.7.0
|
### 1.7.0
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Fixed custom cover background, fixed #52
|
|
||||||
- Fixed sticky sidebar
|
* Fixed custom cover background, fixed [#52](https://github.com/QingWei-Li/docsify/issues/52)
|
||||||
|
* Fixed sticky sidebar
|
||||||
|
|
||||||
### Features
|
### Features
|
||||||
- Add `name` and `nameLink`
|
|
||||||
|
* Add `name` and `nameLink`
|
||||||
|
|
||||||
### 1.6.1
|
### 1.6.1
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Fixed sidebar bug when the coverpage exist
|
|
||||||
|
* Fixed sidebar bug when the coverpage exist
|
||||||
|
|
||||||
### 1.6.0
|
### 1.6.0
|
||||||
|
|
||||||
#### Features
|
#### Features
|
||||||
- Improve sidebar performance. The active item is automatically scrolled in the visible view.
|
|
||||||
- New doc helper: `! `. e.g. `! content` will be rendered as `<p class="tip">content</p>`
|
* Improve sidebar performance. The active item is automatically scrolled in the visible view.
|
||||||
|
* New doc helper: `! `. e.g. `! content` will be rendered as `<p class="tip">content</p>`
|
||||||
|
|
||||||
### 1.5.2
|
### 1.5.2
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Fixed number at the beginning of the slug
|
|
||||||
|
* Fixed number at the beginning of the slug
|
||||||
|
|
||||||
### 1.5.1
|
### 1.5.1
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Remove HTML tag when handling slug
|
|
||||||
|
* Remove HTML tag when handling slug
|
||||||
|
|
||||||
### 1.5.0
|
### 1.5.0
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Fix slugify.
|
|
||||||
- Fix nav highlight.
|
* Fix slugify.
|
||||||
|
* Fix nav highlight.
|
||||||
|
|
||||||
#### Features
|
#### Features
|
||||||
- Initialize the configuration by `window.$docsify`.
|
|
||||||
- Markdown parser is configurable.
|
* Initialize the configuration by `window.$docsify`.
|
||||||
|
* Markdown parser is configurable.
|
||||||
|
|
||||||
### 1.4.3
|
### 1.4.3
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Tweak style.
|
|
||||||
|
* Tweak style.
|
||||||
|
|
||||||
### 1.4.2
|
### 1.4.2
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Fix toggle button style.
|
|
||||||
- Support `mailto`, `tel`, etc. href type
|
|
||||||
- Fix scroll to top.
|
|
||||||
|
|
||||||
|
* Fix toggle button style.
|
||||||
|
* Support `mailto`, `tel`, etc. href type
|
||||||
|
* Fix scroll to top.
|
||||||
|
|
||||||
### 1.4.1
|
### 1.4.1
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Fix generate slug.
|
|
||||||
|
* Fix generate slug.
|
||||||
|
|
||||||
### 1.4.0 Happly new year 🎉
|
### 1.4.0 Happly new year 🎉
|
||||||
|
|
||||||
#### Features
|
#### Features
|
||||||
- Display TOC in the custom sidebar, `data-sub-max-level`.
|
|
||||||
- Custom background in coverpage.
|
* Display TOC in the custom sidebar, `data-sub-max-level`.
|
||||||
|
* Custom background in coverpage.
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Fix scroll highlight when Vue exist.
|
|
||||||
|
* Fix scroll highlight when Vue exist.
|
||||||
|
|
||||||
### 1.3.5
|
### 1.3.5
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Fix vue
|
|
||||||
|
* Fix vue
|
||||||
|
|
||||||
### 1.3.4
|
### 1.3.4
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
|
|
||||||
- Supports [vuep](https://github.com/QingWei-Li/vuep)
|
* Supports [vuep](https://github.com/QingWei-Li/vuep)
|
||||||
|
|
||||||
### 1.3.3
|
### 1.3.3
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Fixed cover rendering timing
|
|
||||||
|
* Fixed cover rendering timing
|
||||||
|
|
||||||
### 1.3.2
|
### 1.3.2
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Fixed render link
|
|
||||||
|
* Fixed render link
|
||||||
|
|
||||||
### 1.3.1
|
### 1.3.1
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Fixed cover page style
|
|
||||||
- Generate the correct link when rendering the article
|
* Fixed cover page style
|
||||||
|
* Generate the correct link when rendering the article
|
||||||
|
|
||||||
### 1.3.0
|
### 1.3.0
|
||||||
|
|
||||||
#### Features
|
#### Features
|
||||||
- Add cover page
|
|
||||||
- add `<kbd>` style
|
* Add cover page
|
||||||
- headling can be cliked
|
* add `<kbd>` style
|
||||||
|
* headling can be cliked
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- sidebar highlight
|
|
||||||
|
|
||||||
|
* sidebar highlight
|
||||||
|
|
||||||
#### break change
|
#### break change
|
||||||
- Navbar no longer fixed at the top
|
|
||||||
|
* Navbar no longer fixed at the top
|
||||||
|
|
||||||
### 1.2.0
|
### 1.2.0
|
||||||
|
|
||||||
#### Features
|
#### Features
|
||||||
- custom basePath
|
|
||||||
- custom homepage
|
* custom basePath
|
||||||
|
* custom homepage
|
||||||
|
|
||||||
### 1.1.7
|
### 1.1.7
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Optimize progress bar
|
|
||||||
|
* Optimize progress bar
|
||||||
|
|
||||||
### 1.1.6
|
### 1.1.6
|
||||||
|
|
||||||
#### Features
|
#### Features
|
||||||
- Add logo 😂
|
|
||||||
|
* Add logo 😂
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Remove table background color
|
|
||||||
- Fixed highlight sidebar using chinese ids
|
* Remove table background color
|
||||||
|
* Fixed highlight sidebar using chinese ids
|
||||||
|
|
||||||
### 1.1.5
|
### 1.1.5
|
||||||
|
|
||||||
#### Features
|
#### Features
|
||||||
|
|
||||||
- Add table style
|
- Add table style
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Not fixed position of hte navbar in the mobile browser
|
|
||||||
- Correct calculation of whether the mobile browser
|
* Not fixed position of hte navbar in the mobile browser
|
||||||
|
* Correct calculation of whether the mobile browser
|
||||||
|
|
||||||
### 1.1.4
|
### 1.1.4
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Fixed chinese auchor link
|
|
||||||
|
* Fixed chinese auchor link
|
||||||
|
|
||||||
### 1.1.3
|
### 1.1.3
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Optimize progress bar again
|
|
||||||
|
* Optimize progress bar again
|
||||||
|
|
||||||
### 1.1.2
|
### 1.1.2
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- fix failed `auto2top` in mobile
|
|
||||||
|
* fix failed `auto2top` in mobile
|
||||||
|
|
||||||
|
|
||||||
### 1.1.1
|
### 1.1.1
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
|
|
||||||
- Optimize progress bar
|
- Optimize progress bar
|
||||||
|
|
||||||
### 1.1.0
|
### 1.1.0
|
||||||
|
|
||||||
#### Features
|
#### Features
|
||||||
- Add progress bar
|
|
||||||
- Add `auto2top` option for hash router
|
* Add progress bar
|
||||||
|
* Add `auto2top` option for hash router
|
||||||
|
|
||||||
### 1.0.3
|
### 1.0.3
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
|
|
||||||
- Fix cache
|
- Fix cache
|
||||||
|
|
||||||
### 1.0.2
|
### 1.0.2
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Fix binding events bug, fixed #24
|
|
||||||
- Fix regular expression, fixed #23
|
* Fix binding events bug, fixed [#24](https://github.com/QingWei-Li/docsify/issues/24)
|
||||||
|
* Fix regular expression, fixed [#23](https://github.com/QingWei-Li/docsify/issues/23)
|
||||||
|
|
||||||
### 1.0.1
|
### 1.0.1
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- `img` style
|
|
||||||
|
* `img` style
|
||||||
|
|
||||||
### 1.0.0
|
### 1.0.0
|
||||||
|
|
||||||
#### Features
|
#### Features
|
||||||
- Support hash router
|
|
||||||
|
* Support hash router
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Improved scrolling on mobile
|
|
||||||
|
* Improved scrolling on mobile
|
||||||
|
|
||||||
### 0.7.0
|
### 0.7.0
|
||||||
|
|
||||||
#### Breaking change
|
#### Breaking change
|
||||||
- `themes/` was removed, only exists in the npm package.
|
|
||||||
|
* `themes/` was removed, only exists in the npm package.
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Fix style.
|
|
||||||
- Fix sidebar animation again.
|
* Fix style.
|
||||||
|
* Fix sidebar animation again.
|
||||||
|
|
||||||
### 0.6.1
|
### 0.6.1
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- In the mobile, it should collapse the sidebar when toggle is clicked.
|
|
||||||
- Fix the dropdown list style.
|
* In the mobile, it should collapse the sidebar when toggle is clicked.
|
||||||
- Fix sidebar animation.
|
* Fix the dropdown list style.
|
||||||
|
* Fix sidebar animation.
|
||||||
|
|
||||||
### 0.6.0
|
### 0.6.0
|
||||||
|
|
||||||
#### Features
|
#### Features
|
||||||
- Navbar support dropdown list, #6
|
|
||||||
- Sidebar with toggle
|
* Navbar support dropdown list, [#6](https://github.com/QingWei-Li/docsify/issues/6)
|
||||||
|
* Sidebar with toggle
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Fix ineffective option, fixed #10
|
|
||||||
|
* Fix ineffective option, fixed [#10](https://github.com/QingWei-Li/docsify/issues/10)
|
||||||
|
|
||||||
### 0.5.0
|
### 0.5.0
|
||||||
|
|
||||||
#### Features
|
#### Features
|
||||||
- Custom sidebars and navbars by markdown file
|
|
||||||
|
* Custom sidebars and navbars by markdown file
|
||||||
|
|
||||||
### 0.4.2
|
### 0.4.2
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Correct catch ajax error
|
|
||||||
|
* Correct catch ajax error
|
||||||
|
|
||||||
### 0.4.1
|
### 0.4.1
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- catch ajax error
|
|
||||||
|
* catch ajax error
|
||||||
|
|
||||||
### 0.4.0
|
### 0.4.0
|
||||||
|
|
||||||
#### Features
|
#### Features
|
||||||
- Custom sidebar
|
|
||||||
|
* Custom sidebar
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Fix undefined language
|
|
||||||
|
* Fix undefined language
|
||||||
|
|
||||||
### 0.3.1
|
### 0.3.1
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Strip HTML tag when rendering the headings
|
|
||||||
|
* Strip HTML tag when rendering the headings
|
||||||
|
|
||||||
### 0.3.0
|
### 0.3.0
|
||||||
|
|
||||||
#### Features
|
#### Features
|
||||||
- Add minified css files
|
|
||||||
- Add max level option
|
* Add minified css files
|
||||||
- Add pure.css
|
* Add max level option
|
||||||
|
* Add pure.css
|
||||||
|
|
||||||
### 0.2.1
|
### 0.2.1
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Fix vue.css
|
|
||||||
|
* Fix vue.css
|
||||||
|
|
||||||
### 0.2.0
|
### 0.2.0
|
||||||
|
|
||||||
#### Bug fixes
|
#### Bug fixes
|
||||||
- Fix route
|
|
||||||
- Remove dynamic title
|
* Fix route
|
||||||
|
* Remove dynamic title
|
||||||
|
|
||||||
### 0.1.0
|
### 0.1.0
|
||||||
|
|
||||||
#### Features
|
#### Features
|
||||||
- Add buble.css
|
|
||||||
|
* Add buble.css
|
||||||
|
|
|
||||||
27
README.md
27
README.md
|
|
@ -15,6 +15,7 @@
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
## Links
|
## Links
|
||||||
|
|
||||||
- [Documentation](https://docsify.js.org)
|
- [Documentation](https://docsify.js.org)
|
||||||
- [CLI](https://github.com/QingWei-Li/docsify-cli)
|
- [CLI](https://github.com/QingWei-Li/docsify-cli)
|
||||||
|
|
||||||
|
|
@ -28,7 +29,8 @@
|
||||||
- Compatible with IE10+
|
- Compatible with IE10+
|
||||||
|
|
||||||
## Quick start
|
## Quick start
|
||||||
Create a `index.html`.
|
|
||||||
|
Create an `index.html`.
|
||||||
|
|
||||||
```html
|
```html
|
||||||
<!-- index.html -->
|
<!-- index.html -->
|
||||||
|
|
@ -51,18 +53,24 @@ Create a `index.html`.
|
||||||
Modern browsers and Internet Explorer 10+.
|
Modern browsers and Internet Explorer 10+.
|
||||||
|
|
||||||
## Showcase
|
## Showcase
|
||||||
|
|
||||||
These open-source projects are using docsify to generate their sites. Pull requests welcome :blush:
|
These open-source projects are using docsify to generate their sites. Pull requests welcome :blush:
|
||||||
|
|
||||||
- [Snipaste](https://docs.snipaste.com/) - Snip & Paste
|
| Project | Description |
|
||||||
- [puck](https://puck.zz173.com/) - A small & magical php framework.
|
|---|---|
|
||||||
- [Samaritan](http://samaritan.stockdb.org) - An Algorithmic Trading Framework for Digital Currency.
|
| [Snipaste](https://docs.snipaste.com/) | Snip & Paste |
|
||||||
- [Vudash](http://vudash.github.io/vudash/) - Powerful, Flexible, Open Source dashboards for anything
|
| [puck](https://puck.zz173.com/) | A small & magical php framework. |
|
||||||
- [Trilogy](http://trilogy.js.org) - No-hassle SQLite with a Promise-based, document store style API.
|
| [Samaritan](http://samaritan.stockdb.org) | An Algorithmic Trading Framework for Digital Currency. |
|
||||||
- [Mybatis-Plus](http://mp.baomidou.com/) - An enhanced toolkit of Mybatis to simplify development
|
| [Vudash](http://vudash.github.io/vudash/) | Powerful, Flexible, Open Source dashboards for anything |
|
||||||
|
| [Trilogy](http://trilogy.js.org) | No-hassle SQLite with a Promise-based, document store style API. |
|
||||||
|
| [Mybatis-Plus](http://mp.baomidou.com/) | An enhanced toolkit of Mybatis to simplify development |
|
||||||
|
|
||||||
## Similar projects
|
## Similar projects
|
||||||
- [docute](https://github.com/egoist/docute) - 📜 Effortlessly documentation done right
|
|
||||||
- [docpress](https://github.com/docpress/docpress) - Documentation website generator
|
| Project | Description |
|
||||||
|
|---|---|
|
||||||
|
| [docute](https://github.com/egoist/docute) | 📜 Effortlessly documentation done right |
|
||||||
|
| [docpress](https://github.com/docpress/docpress) | Documentation website generator |
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
|
|
@ -81,4 +89,5 @@ open http://localhost:3000
|
||||||
```
|
```
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
MIT
|
MIT
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue