-
-
-### Backers
-
-Thank you to all our backers! [[Become a backer](https://opencollective.com/docsify#backer)]
-
-
-
-
-### Sponsors
-
-Thank you to all our sponsors! (please ask your company to also support this open source project by [becoming a sponsor](https://opencollective.com/docsify#sponsor))
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/HISTORY.md b/HISTORY.md
index fb720fd..d3cc3e3 100644
--- a/HISTORY.md
+++ b/HISTORY.md
@@ -1,736 +1,287 @@
+### 1.10.5
+#### Bug fixes
+- fix initialize the Vue instance
-
-## [3.7.3](https://github.com/QingWei-Li/docsify/compare/v3.7.2...v3.7.3) (2017-05-22)
+### 1.10.4
+#### Bug fixes
+- fix execute script
+### 1.10.3
+#### Bug fixes
+- compatible vuep QingWei-Li/vuep/issues/2
+- fix sidebar scroll, fixed #63
-### Bug Fixes
+### 1.10.2
+#### Bug fixes
+- Fix render emojis again
-* **render:** find => filter ([eca3368](https://github.com/QingWei-Li/docsify/commit/eca3368))
+### 1.10.1
+#### Bug fixes
+- Fix render emojis
+### 1.10.0
+#### Features
+- Support emoji :laughing:
+### 1.9.0
-
-## [3.7.2](https://github.com/QingWei-Li/docsify/compare/v3.7.1...v3.7.2) (2017-05-19)
+#### Bug fixes
+- Destroys the vue instance when the route is changed
+#### Features
+- Add `!>` and `?>` doc helper.
+#### Break change
+- Remove `!` doc helper.
-
-## [3.7.1](https://github.com/QingWei-Li/docsify/compare/v3.7.0...v3.7.1) (2017-05-19)
-
-
-### Bug Fixes
-
-* docsify-updated is undefined ([b2b4742](https://github.com/QingWei-Li/docsify/commit/b2b4742))
-
-
-
-
-# [3.7.0](https://github.com/QingWei-Li/docsify/compare/v3.6.6...v3.7.0) (2017-05-16)
-
+### 1.8.0
+#### Bug fixes
+- Using `v-pre` skip compilation.
### Features
+- Execute script when vue exists.
-* add docsify-updated, close [#158](https://github.com/QingWei-Li/docsify/issues/158) ([d2be5ae](https://github.com/QingWei-Li/docsify/commit/d2be5ae))
-* add externalLinkTarget, close [#149](https://github.com/QingWei-Li/docsify/issues/149) ([2d73285](https://github.com/QingWei-Li/docsify/commit/2d73285))
+### 1.7.4
+#### Bug fixes
+- Fix bugs caused by the previous version
+### 1.7.3
+#### Bug fixes
+- Add `hr` style
+- Fixed option is an empty string
+### 1.7.2
+#### Bug fixes
+- Fix sidebar click event in mobile browser.
-
-## [3.6.6](https://github.com/QingWei-Li/docsify/compare/v3.6.5...v3.6.6) (2017-05-06)
+### 1.7.1
+#### Bug fixes
+- Fix sidebar style in mobile browser.
+### 1.7.0
+
+#### Bug fixes
+- Fixed custom cover background, fixed #52
+- Fixed sticky sidebar
### Features
+- Add `name` and `nameLink`
-* support query string for the search, fixed [#156](https://github.com/QingWei-Li/docsify/issues/156) ([da75d70](https://github.com/QingWei-Li/docsify/commit/da75d70))
+### 1.6.1
+#### Bug fixes
+- Fixed sidebar bug when the coverpage exist
+### 1.6.0
+#### Features
+- Improve sidebar performance. The active item is automatically scrolled in the visible view.
+- New doc helper: `! `. e.g. `! content` will be rendered as `content
` +### 1.5.2 +#### Bug fixes +- Fixed number at the beginning of the slug - -## [3.6.5](https://github.com/QingWei-Li/docsify/compare/v3.6.4...v3.6.5) (2017-04-28) +### 1.5.1 +#### Bug fixes +- Remove HTML tag when handling slug +### 1.5.0 -### Bug Fixes +#### Bug fixes +- Fix slugify. +- Fix nav highlight. -* **util:** fix crash, fixed [#154](https://github.com/QingWei-Li/docsify/issues/154) ([51832d3](https://github.com/QingWei-Li/docsify/commit/51832d3)) +#### Features +- Initialize the configuration by `window.$docsify`. +- Markdown parser is configurable. +### 1.4.3 +#### Bug fixes +- Tweak style. +### 1.4.2 - -## [3.6.4](https://github.com/QingWei-Li/docsify/compare/v3.6.3...v3.6.4) (2017-04-28) +#### Bug fixes +- Fix toggle button style. +- Support `mailto`, `tel`, etc. href type +- Fix scroll to top. -### Bug Fixes +### 1.4.1 +#### Bug fixes +- Fix generate slug. -* **util:** correctly clean up duplicate slashes, fixed [#153](https://github.com/QingWei-Li/docsify/issues/153) ([76c041a](https://github.com/QingWei-Li/docsify/commit/76c041a)) +### 1.4.0 Happly new year 🎉 +#### Features +- Display TOC in the custom sidebar, `data-sub-max-level`. +- Custom background in coverpage. +#### Bug fixes +- Fix scroll highlight when Vue exist. +### 1.3.5 +#### Bug fixes +- Fix vue - -## [3.6.3](https://github.com/QingWei-Li/docsify/compare/v3.6.2...v3.6.3) (2017-04-25) +### 1.3.4 +#### Bug fixes +- Supports [vuep](https://github.com/QingWei-Li/vuep) -### Bug Fixes +### 1.3.3 +#### Bug fixes +- Fixed cover rendering timing -* **external-script:** script attrs ([2653849](https://github.com/QingWei-Li/docsify/commit/2653849)) +### 1.3.2 +#### Bug fixes +- Fixed render link +### 1.3.1 - -## [3.6.2](https://github.com/QingWei-Li/docsify/compare/v3.6.0...v3.6.2) (2017-04-12) +#### Bug fixes +- Fixed cover page style +- Generate the correct link when rendering the article +### 1.3.0 +#### Features +- Add cover page +- add `` style +- headling can be cliked -### Features +#### Bug fixes +- sidebar highlight -* **event:** Collapse the sidebar when click outside element in the small screen ([9b7e5f5](https://github.com/QingWei-Li/docsify/commit/9b7e5f5)) -* **external-script:** detect more than one script dom, fixed [#146](https://github.com/QingWei-Li/docsify/issues/146) ([94d6603](https://github.com/QingWei-Li/docsify/commit/94d6603)) +#### break change +- Navbar no longer fixed at the top +### 1.2.0 +#### Features +- custom basePath +- custom homepage - -# [3.6.0](https://github.com/QingWei-Li/docsify/compare/v3.5.2...v3.6.0) (2017-04-09) +### 1.1.7 +#### Bug fixes +- Optimize progress bar +### 1.1.6 +#### Features +- Add logo 😂 -### Features +#### Bug fixes +- Remove table background color +- Fixed highlight sidebar using chinese ids -* **render:** add mergeNavbar option, close [#125](https://github.com/QingWei-Li/docsify/issues/125), [#124](https://github.com/QingWei-Li/docsify/issues/124) ([#145](https://github.com/QingWei-Li/docsify/issues/145)) ([9220523](https://github.com/QingWei-Li/docsify/commit/9220523)) +### 1.1.5 +#### Features +- Add table style +#### Bug fixes +- Not fixed position of hte navbar in the mobile browser +- Correct calculation of whether the mobile browser +### 1.1.4 +#### Bug fixes +- Fixed chinese auchor link - -## [3.5.2](https://github.com/QingWei-Li/docsify/compare/v3.5.1...v3.5.2) (2017-04-05) +### 1.1.3 +#### Bug fixes +- Optimize progress bar again +### 1.1.2 +#### Bug fixes +- fix failed `auto2top` in mobile - -## [3.5.1](https://github.com/QingWei-Li/docsify/compare/v3.5.0...v3.5.1) (2017-03-25) +### 1.1.1 +#### Bug fixes +- Optimize progress bar +### 1.1.0 +#### Features +- Add progress bar +- Add `auto2top` option for hash router -### Bug Fixes +### 1.0.3 +#### Bug fixes +- Fix cache -* .md file extension regex ([594299f](https://github.com/QingWei-Li/docsify/commit/594299f)) +### 1.0.2 +#### Bug fixes +- Fix binding events bug, fixed #24 +- Fix regular expression, fixed #23 +### 1.0.1 +#### Bug fixes +- `img` style +### 1.0.0 +#### Features +- Support hash router - -# [3.5.0](https://github.com/QingWei-Li/docsify/compare/v3.4.4...v3.5.0) (2017-03-25) +#### Bug fixes +- Improved scrolling on mobile +### 0.7.0 +#### Breaking change +- `themes/` was removed, only exists in the npm package. -### Bug Fixes +#### Bug fixes +- Fix style. +- Fix sidebar animation again. -* adjust display on small screens ([bf35471](https://github.com/QingWei-Li/docsify/commit/bf35471)) -* navbar labels for German ([b022aaf](https://github.com/QingWei-Li/docsify/commit/b022aaf)) +### 0.6.1 +#### Bug fixes +- In the mobile, it should collapse the sidebar when toggle is clicked. +- Fix the dropdown list style. +- Fix sidebar animation. +### 0.6.0 +#### Features +- Navbar support dropdown list, #6 +- Sidebar with toggle -### Features +#### Bug fixes +- Fix ineffective option, fixed #10 -* **route:** auto remove .md extension ([8f11653](https://github.com/QingWei-Li/docsify/commit/8f11653)) +### 0.5.0 +#### Features +- Custom sidebars and navbars by markdown file +### 0.4.2 +#### Bug fixes +- Correct catch ajax error +### 0.4.1 +#### Bug fixes +- catch ajax error + +### 0.4.0 +#### Features +- Custom sidebar - -## [3.4.4](https://github.com/QingWei-Li/docsify/compare/v3.4.3...v3.4.4) (2017-03-17) +#### Bug fixes +- Fix undefined language +### 0.3.1 +#### Bug fixes +- Strip HTML tag when rendering the headings -### Bug Fixes - -* **search:** fix input style ([2d6a51b](https://github.com/QingWei-Li/docsify/commit/2d6a51b)) - - - - -## [3.4.3](https://github.com/QingWei-Li/docsify/compare/v3.4.2...v3.4.3) (2017-03-16) - - - - -## [3.4.2](https://github.com/QingWei-Li/docsify/compare/v3.4.1...v3.4.2) (2017-03-11) - - -### Features - -* **emojify:** add no-emoji option ([3aef37a](https://github.com/QingWei-Li/docsify/commit/3aef37a)) - - - - -## [3.4.1](https://github.com/QingWei-Li/docsify/compare/v3.4.0...v3.4.1) (2017-03-10) - - -### Bug Fixes - -* **dom:** Disable the dom cache when vue is present, fixed [#119](https://github.com/QingWei-Li/docsify/issues/119) ([b9a7275](https://github.com/QingWei-Li/docsify/commit/b9a7275)) - - - - -# [3.4.0](https://github.com/QingWei-Li/docsify/compare/v3.3.0...v3.4.0) (2017-03-09) - - -### Features - -* **zoom-image:** add plugin ([50fa6fc](https://github.com/QingWei-Li/docsify/commit/50fa6fc)) - - - - -# [3.3.0](https://github.com/QingWei-Li/docsify/compare/v3.2.0...v3.3.0) (2017-03-07) - - - - -# [3.2.0](https://github.com/QingWei-Li/docsify/compare/v3.1.2...v3.2.0) (2017-02-28) - - -### Bug Fixes - -* **fetch:** load sidebar and navbar for parent path, fixed [#100](https://github.com/QingWei-Li/docsify/issues/100) ([f3fc596](https://github.com/QingWei-Li/docsify/commit/f3fc596)) -* **render:** Toc rendering error, fixed [#106](https://github.com/QingWei-Li/docsify/issues/106) ([0d59ee9](https://github.com/QingWei-Li/docsify/commit/0d59ee9)) - - -### Features - -* **search:** Localization for no data tip, close [#103](https://github.com/QingWei-Li/docsify/issues/103) ([d3c9fbd](https://github.com/QingWei-Li/docsify/commit/d3c9fbd)) - - - - -## [3.1.2](https://github.com/QingWei-Li/docsify/compare/v3.1.1...v3.1.2) (2017-02-27) - - - - -## [3.1.1](https://github.com/QingWei-Li/docsify/compare/v3.1.0...v3.1.1) (2017-02-24) - - -### Bug Fixes - -* **render:** custom cover background image ([8f9bf29](https://github.com/QingWei-Li/docsify/commit/8f9bf29)) -* **search:** don't search nameLink, fixed [#102](https://github.com/QingWei-Li/docsify/issues/102) ([507d9e8](https://github.com/QingWei-Li/docsify/commit/507d9e8)) -* **tpl:** extra character, fixed [#101](https://github.com/QingWei-Li/docsify/issues/101) ([d67d25f](https://github.com/QingWei-Li/docsify/commit/d67d25f)) - - - - -# [3.1.0](https://github.com/QingWei-Li/docsify/compare/v3.0.5...v3.1.0) (2017-02-22) - - -### Bug Fixes - -* **search:** incorrect anchor link, fixed [#90](https://github.com/QingWei-Li/docsify/issues/90) ([b8a3d8f](https://github.com/QingWei-Li/docsify/commit/b8a3d8f)) -* **sw:** update white list ([f2975a5](https://github.com/QingWei-Li/docsify/commit/f2975a5)) - - -### Features - -* **emoji:** add emoji plugin ([855c450](https://github.com/QingWei-Li/docsify/commit/855c450)) - - - - -## [3.0.5](https://github.com/QingWei-Li/docsify/compare/v3.0.4...v3.0.5) (2017-02-21) - - -### Bug Fixes - -* **event:** highlight sidebar when clicked, fixed [#86](https://github.com/QingWei-Li/docsify/issues/86) ([2a1157a](https://github.com/QingWei-Li/docsify/commit/2a1157a)) -* **gen-tree:** cache toc list, fixed [#88](https://github.com/QingWei-Li/docsify/issues/88) ([3394ebb](https://github.com/QingWei-Li/docsify/commit/3394ebb)) -* **layout.css:** loading style ([42b2dba](https://github.com/QingWei-Li/docsify/commit/42b2dba)) - - -### Features - -* **pwa:** add sw.js ([f7111b5](https://github.com/QingWei-Li/docsify/commit/f7111b5)) - - - - -## [3.0.4](https://github.com/QingWei-Li/docsify/compare/v3.0.3...v3.0.4) (2017-02-20) - - -### Bug Fixes - -* **render:** disable rendering sub list when loadSidebar is false ([35dd2e1](https://github.com/QingWei-Li/docsify/commit/35dd2e1)) -* **render:** execute script ([780c1e5](https://github.com/QingWei-Li/docsify/commit/780c1e5)) - - - - -## [3.0.3](https://github.com/QingWei-Li/docsify/compare/v3.0.2...v3.0.3) (2017-02-19) - - - - -## [3.0.2](https://github.com/QingWei-Li/docsify/compare/v3.0.1...v3.0.2) (2017-02-19) - - -### Bug Fixes - -* **compiler:** link ([3b127a1](https://github.com/QingWei-Li/docsify/commit/3b127a1)) -* **search:** add lazy input ([bf593a7](https://github.com/QingWei-Li/docsify/commit/bf593a7)) - - - - -## [3.0.1](https://github.com/QingWei-Li/docsify/compare/v3.0.0...v3.0.1) (2017-02-19) - - -### Bug Fixes - -* **route:** empty alias ([cd99b52](https://github.com/QingWei-Li/docsify/commit/cd99b52)) - - - - -# [3.0.0](https://github.com/QingWei-Li/docsify/compare/v2.4.3...v3.0.0) (2017-02-19) - - -### Bug Fixes - -* **compiler:** link ([c7e09c3](https://github.com/QingWei-Li/docsify/commit/c7e09c3)) -* **render:** support html file ([7b6a2ac](https://github.com/QingWei-Li/docsify/commit/7b6a2ac)) -* **search:** escape html ([fcb66e8](https://github.com/QingWei-Li/docsify/commit/fcb66e8)) -* **search:** fix default config ([2efd859](https://github.com/QingWei-Li/docsify/commit/2efd859)) - - -### Features - -* **front-matter:** add front matter[WIP] ([dbb9278](https://github.com/QingWei-Li/docsify/commit/dbb9278)) -* **render:** add auto header ([b7768b1](https://github.com/QingWei-Li/docsify/commit/b7768b1)) -* **search:** Localization for search placeholder, close [#80](https://github.com/QingWei-Li/docsify/issues/80) ([2351c3e](https://github.com/QingWei-Li/docsify/commit/2351c3e)) -* **themes:** add loading info ([86594a3](https://github.com/QingWei-Li/docsify/commit/86594a3)) - - - - -## [2.4.3](https://github.com/QingWei-Li/docsify/compare/v2.4.2...v2.4.3) (2017-02-15) - - - - -## [2.4.2](https://github.com/QingWei-Li/docsify/compare/v2.4.1...v2.4.2) (2017-02-14) - - -### Bug Fixes - -* **index:** load file path error ([dc536a3](https://github.com/QingWei-Li/docsify/commit/dc536a3)) - - - - -## [2.4.1](https://github.com/QingWei-Li/docsify/compare/v2.4.0...v2.4.1) (2017-02-13) - - -### Bug Fixes - -* **index:** cover page ([dd0c84b](https://github.com/QingWei-Li/docsify/commit/dd0c84b)) - - - - -# [2.4.0](https://github.com/QingWei-Li/docsify/compare/v2.3.0...v2.4.0) (2017-02-13) - - -### Features - -* **hook:** add doneEach ([c6f7602](https://github.com/QingWei-Li/docsify/commit/c6f7602)) - - - - -# [2.3.0](https://github.com/QingWei-Li/docsify/compare/v2.2.1...v2.3.0) (2017-02-13) - - -### Bug Fixes - -* **event:** has no effect on a FF mobile browser, fixed [#67](https://github.com/QingWei-Li/docsify/issues/67) ([0ff36c2](https://github.com/QingWei-Li/docsify/commit/0ff36c2)) -* **render:** custom marked renderer ([bf559b4](https://github.com/QingWei-Li/docsify/commit/bf559b4)) -* **render:** fix render link ([a866744](https://github.com/QingWei-Li/docsify/commit/a866744)) -* **render:** image url ([6f87529](https://github.com/QingWei-Li/docsify/commit/6f87529)) -* **render:** render link ([38ea660](https://github.com/QingWei-Li/docsify/commit/38ea660)) -* **src:** fix route ([324301a](https://github.com/QingWei-Li/docsify/commit/324301a)) -* **src:** get alias ([784173e](https://github.com/QingWei-Li/docsify/commit/784173e)) -* **src:** get alias ([ce99a04](https://github.com/QingWei-Li/docsify/commit/ce99a04)) -* **themes:** fix navbar style ([fa54b52](https://github.com/QingWei-Li/docsify/commit/fa54b52)) -* **themes:** update navbar style ([4864d1b](https://github.com/QingWei-Li/docsify/commit/4864d1b)) - - -### Features - -* **hook:** support custom plugin ([9e81a59](https://github.com/QingWei-Li/docsify/commit/9e81a59)) -* **src:** add alias feature ([24412cd](https://github.com/QingWei-Li/docsify/commit/24412cd)) -* **src:** dynamic title and fix sidebar style ([6b30eb6](https://github.com/QingWei-Li/docsify/commit/6b30eb6)) - - - - -## [2.2.1](https://github.com/QingWei-Li/docsify/compare/v2.2.0...v2.2.1) (2017-02-11) - - -### Bug Fixes - -* **event:** scroll active sidebar ([50f5fc2](https://github.com/QingWei-Li/docsify/commit/50f5fc2)) -* **search:** crash when not content, fixed [#68](https://github.com/QingWei-Li/docsify/issues/68) ([9d3cc89](https://github.com/QingWei-Li/docsify/commit/9d3cc89)) -* **search:** not work in mobile ([3941304](https://github.com/QingWei-Li/docsify/commit/3941304)) - - - - -# [2.2.0](https://github.com/QingWei-Li/docsify/compare/v2.1.0...v2.2.0) (2017-02-09) - - -### Features - -* **plugins:** add Google Analytics plugin ([#66](https://github.com/QingWei-Li/docsify/issues/66)) ([ac61bb0](https://github.com/QingWei-Li/docsify/commit/ac61bb0)) - - - - -# [2.1.0](https://github.com/QingWei-Li/docsify/compare/v2.0.3...v2.1.0) (2017-02-09) - - -### Bug Fixes - -* render name ([12e2479](https://github.com/QingWei-Li/docsify/commit/12e2479)) -* **vue.css:** update sidebar style ([fc140ef](https://github.com/QingWei-Li/docsify/commit/fc140ef)) - - -### Features - -* add search, close [#43](https://github.com/QingWei-Li/docsify/issues/43) ([eb5ff3e](https://github.com/QingWei-Li/docsify/commit/eb5ff3e)) - - - - -## [2.0.3](https://github.com/QingWei-Li/docsify/compare/v2.0.2...v2.0.3) (2017-02-07) - - -### Bug Fixes - -* css var polyfill ([8cd386a](https://github.com/QingWei-Li/docsify/commit/8cd386a)) -* css var polyfill ([cbaee21](https://github.com/QingWei-Li/docsify/commit/cbaee21)) -* rendering emojis ([8c7e4d7](https://github.com/QingWei-Li/docsify/commit/8c7e4d7)) - - - - -## [2.0.2](https://github.com/QingWei-Li/docsify/compare/v2.0.1...v2.0.2) (2017-02-05) - - -### Bug Fixes - -* button style in cover page ([4470855](https://github.com/QingWei-Li/docsify/commit/4470855)) - - - - -## [2.0.1](https://github.com/QingWei-Li/docsify/compare/v2.0.0...v2.0.1) (2017-02-05) - - - - -# [2.0.0](https://github.com/QingWei-Li/docsify/compare/v1.10.5...v2.0.0) (2017-02-05) - - -### Features - -* customize the theme color ([5cc9f05](https://github.com/QingWei-Li/docsify/commit/5cc9f05)) - - - - -## [1.10.5](https://github.com/QingWei-Li/docsify/compare/v1.10.4...v1.10.5) (2017-01-28) - - - - -## [1.10.4](https://github.com/QingWei-Li/docsify/compare/v1.10.3...v1.10.4) (2017-01-27) - - - - -## [1.10.3](https://github.com/QingWei-Li/docsify/compare/v1.10.2...v1.10.3) (2017-01-27) - - - - -## [1.10.2](https://github.com/QingWei-Li/docsify/compare/v1.10.1...v1.10.2) (2017-01-25) - - - - -## [1.10.1](https://github.com/QingWei-Li/docsify/compare/v1.10.0...v1.10.1) (2017-01-25) - - - - -# [1.10.0](https://github.com/QingWei-Li/docsify/compare/v1.9.0...v1.10.0) (2017-01-25) - - - - -# [1.9.0](https://github.com/QingWei-Li/docsify/compare/v1.8.0...v1.9.0) (2017-01-24) - - - - -# [1.8.0](https://github.com/QingWei-Li/docsify/compare/v1.7.4...v1.8.0) (2017-01-24) - - - - -## [1.7.4](https://github.com/QingWei-Li/docsify/compare/v1.7.3...v1.7.4) (2017-01-13) - - - - -## [1.7.3](https://github.com/QingWei-Li/docsify/compare/v1.7.2...v1.7.3) (2017-01-13) - - - - -## [1.7.2](https://github.com/QingWei-Li/docsify/compare/v1.7.1...v1.7.2) (2017-01-12) - - - - -## [1.7.1](https://github.com/QingWei-Li/docsify/compare/v1.7.0...v1.7.1) (2017-01-12) - - - - -# [1.7.0](https://github.com/QingWei-Li/docsify/compare/v1.6.1...v1.7.0) (2017-01-12) - - - - -## [1.6.1](https://github.com/QingWei-Li/docsify/compare/v1.6.0...v1.6.1) (2017-01-10) - - - - -# [1.6.0](https://github.com/QingWei-Li/docsify/compare/v1.5.2...v1.6.0) (2017-01-10) - - - - -## [1.5.2](https://github.com/QingWei-Li/docsify/compare/v1.5.1...v1.5.2) (2017-01-10) - - - - -## [1.5.1](https://github.com/QingWei-Li/docsify/compare/v1.5.0...v1.5.1) (2017-01-09) - - - - -# [1.5.0](https://github.com/QingWei-Li/docsify/compare/v1.4.3...v1.5.0) (2017-01-04) - - -### Features - -* Markdown parser is configurable, [#42](https://github.com/QingWei-Li/docsify/issues/42) ([8b1000a](https://github.com/QingWei-Li/docsify/commit/8b1000a)) - - - - -## [1.4.3](https://github.com/QingWei-Li/docsify/compare/v1.4.2...v1.4.3) (2017-01-01) - - - - -## [1.4.2](https://github.com/QingWei-Li/docsify/compare/v1.4.1...v1.4.2) (2016-12-31) - - - - -## [1.4.1](https://github.com/QingWei-Li/docsify/compare/v1.4.0...v1.4.1) (2016-12-31) - - - - -# [1.4.0](https://github.com/QingWei-Li/docsify/compare/v1.3.5...v1.4.0) (2016-12-31) - - - - -## [1.3.5](https://github.com/QingWei-Li/docsify/compare/v1.3.4...v1.3.5) (2016-12-25) - - - - -## [1.3.4](https://github.com/QingWei-Li/docsify/compare/v1.3.3...v1.3.4) (2016-12-25) - - - - -## [1.3.3](https://github.com/QingWei-Li/docsify/compare/v1.3.2...v1.3.3) (2016-12-23) - - - - -## [1.3.2](https://github.com/QingWei-Li/docsify/compare/v1.3.1...v1.3.2) (2016-12-22) - - - - -## [1.3.1](https://github.com/QingWei-Li/docsify/compare/v1.3.0...v1.3.1) (2016-12-22) - - - - -# [1.3.0](https://github.com/QingWei-Li/docsify/compare/v1.2.0...v1.3.0) (2016-12-21) - - - - -# [1.2.0](https://github.com/QingWei-Li/docsify/compare/v1.1.7...v1.2.0) (2016-12-20) - - - - -## [1.1.7](https://github.com/QingWei-Li/docsify/compare/v1.1.6...v1.1.7) (2016-12-19) - - - - -## [1.1.6](https://github.com/QingWei-Li/docsify/compare/v1.1.5...v1.1.6) (2016-12-18) - - - - -## [1.1.5](https://github.com/QingWei-Li/docsify/compare/v1.1.4...v1.1.5) (2016-12-18) - - - - -## [1.1.4](https://github.com/QingWei-Li/docsify/compare/v1.1.3...v1.1.4) (2016-12-17) - - - - -## [1.1.3](https://github.com/QingWei-Li/docsify/compare/v1.1.2...v1.1.3) (2016-12-17) - - - - -## [1.1.2](https://github.com/QingWei-Li/docsify/compare/v1.1.1...v1.1.2) (2016-12-17) - - - - -## [1.1.1](https://github.com/QingWei-Li/docsify/compare/v1.1.0...v1.1.1) (2016-12-17) - - - - -# [1.1.0](https://github.com/QingWei-Li/docsify/compare/v1.0.3...v1.1.0) (2016-12-16) - - - - -## [1.0.3](https://github.com/QingWei-Li/docsify/compare/v1.0.2...v1.0.3) (2016-12-13) - - - - -## [1.0.2](https://github.com/QingWei-Li/docsify/compare/v1.0.1...v1.0.2) (2016-12-13) - - - - -## [1.0.1](https://github.com/QingWei-Li/docsify/compare/v1.0.0...v1.0.1) (2016-12-08) - - - - -# [1.0.0](https://github.com/QingWei-Li/docsify/compare/v0.7.0...v1.0.0) (2016-12-08) - - - - -# [0.7.0](https://github.com/QingWei-Li/docsify/compare/v0.6.1...v0.7.0) (2016-11-30) - - - - -## [0.6.1](https://github.com/QingWei-Li/docsify/compare/v0.6.0...v0.6.1) (2016-11-29) - - - - -# [0.6.0](https://github.com/QingWei-Li/docsify/compare/v0.5.0...v0.6.0) (2016-11-29) - - - - -# [0.5.0](https://github.com/QingWei-Li/docsify/compare/v0.4.2...v0.5.0) (2016-11-28) - - - - -## [0.4.2](https://github.com/QingWei-Li/docsify/compare/v0.4.1...v0.4.2) (2016-11-28) - - - - -## [0.4.1](https://github.com/QingWei-Li/docsify/compare/v0.4.0...v0.4.1) (2016-11-28) - - - - -# [0.4.0](https://github.com/QingWei-Li/docsify/compare/v0.3.1...v0.4.0) (2016-11-27) - - -### Features - -* custom sidebar, [#4](https://github.com/QingWei-Li/docsify/issues/4) ([#5](https://github.com/QingWei-Li/docsify/issues/5)) ([37e7984](https://github.com/QingWei-Li/docsify/commit/37e7984)) - - - - -## [0.3.1](https://github.com/QingWei-Li/docsify/compare/v0.3.0...v0.3.1) (2016-11-27) - - - - -# [0.3.0](https://github.com/QingWei-Li/docsify/compare/v0.2.1...v0.3.0) (2016-11-27) - - - - -## [0.2.1](https://github.com/QingWei-Li/docsify/compare/v0.2.0...v0.2.1) (2016-11-26) - - - - -# [0.2.0](https://github.com/QingWei-Li/docsify/compare/v0.1.0...v0.2.0) (2016-11-26) - - - - -# [0.1.0](https://github.com/QingWei-Li/docsify/compare/v0.0.5...v0.1.0) (2016-11-26) - - - - -## [0.0.5](https://github.com/QingWei-Li/docsify/compare/v0.0.4...v0.0.5) (2016-11-24) - - - - -## [0.0.4](https://github.com/QingWei-Li/docsify/compare/v0.0.3...v0.0.4) (2016-11-22) - - - - -## [0.0.3](https://github.com/QingWei-Li/docsify/compare/v0.0.2...v0.0.3) (2016-11-20) - - - - -## [0.0.2](https://github.com/QingWei-Li/docsify/compare/v0.0.1...v0.0.2) (2016-11-20) - - - - -## 0.0.1 (2016-11-20) +### 0.3.0 +#### Features +- Add minified css files +- Add max level option +- Add pure.css + +### 0.2.1 +#### Bug fixes +- Fix vue.css + +### 0.2.0 +#### Bug fixes +- Fix route +- Remove dynamic title + +### 0.1.0 +#### Features +- Add buble.css \ No newline at end of file diff --git a/LICENSE b/LICENSE index 37a4ac5..58492da 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2016 - present cinwell.li +Copyright (c) 2016 - 2017 cinwell.li Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index b8da0d8..88937d1 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ @@ -9,60 +9,59 @@
- 
- 
- 
+ 
- 
-
Gold Sponsor via Open Collective
- -
-
- 
-
-
-## Sponsors
-
-Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/docsify#silver-sponsors)]
-
-
-
-
-
-
-
-
-
-
-
-
-## Contributors
-
-This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
-
-
## License
-
-[MIT](LICENSE)
-
-[](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Fdocsifyjs%2Fdocsify?ref=badge_large)
+MIT
diff --git a/app.js b/app.js
new file mode 100644
index 0000000..beada16
--- /dev/null
+++ b/app.js
@@ -0,0 +1,12 @@
+var serveStatic = require('serve-static')
+var http = require('http')
+var fs = require('fs')
+
+http.createServer(function (req, res) {
+ serveStatic('.')(req, res, function () {
+ res.writeHead(404, { 'Content-Type': 'text/html' })
+ res.end(fs.readFileSync('dev.html'))
+ })
+}).listen(3000, '0.0.0.0')
+
+console.log(`\nListening at http://0.0.0.0:3000\n`)
diff --git a/build/build-css.js b/build/build-css.js
new file mode 100644
index 0000000..40672e0
--- /dev/null
+++ b/build/build-css.js
@@ -0,0 +1,47 @@
+var fs = require('fs')
+var cssnano = require('cssnano').process
+var resolve = require('path').resolve
+var postcss = require('postcss')
+var isProd = process.argv[process.argv.length - 1] !== '--dev'
+
+var processor = postcss([require('postcss-salad')({
+ features: {
+ precss: {
+ properties: {
+ preserve: true
+ }
+ }
+ }
+})])
+
+var saveMin = function (file, content) {
+ fs.writeFileSync(resolve(__dirname, '../lib/themes/', file), content)
+}
+var save = function (file, content) {
+ fs.writeFileSync(resolve(__dirname, '../themes/', file), content)
+}
+var load = function (file) {
+ return fs.readFileSync(resolve(__dirname, '../src/themes/', file)).toString()
+}
+var loadLib = function (file) {
+ return fs.readFileSync(resolve(__dirname, '../themes/', file)).toString()
+}
+
+var list = fs.readdirSync(resolve(__dirname, '../src/themes'))
+
+list.forEach(function (file) {
+ if (!/\.css$/.test(file)) return
+ processor.process(load(file), { from: resolve(__dirname, '../src/themes/', file) })
+ .then(function (result) {
+ save(file, result.css)
+ console.log('salad - ' + file)
+ isProd && cssnano(loadLib(file))
+ .then(function (result) {
+ saveMin(file, result.css)
+ console.log('cssnao - ' + file)
+ })
+ }).catch(function (err) {
+ console.log(err)
+ })
+})
+
diff --git a/build/build.js b/build/build.js
index 7b61224..cbeefc9 100644
--- a/build/build.js
+++ b/build/build.js
@@ -1,119 +1,60 @@
-const rollup = require('rollup')
-const buble = require('rollup-plugin-buble')
-const commonjs = require('rollup-plugin-commonjs')
-const nodeResolve = require('rollup-plugin-node-resolve')
-const uglify = require('rollup-plugin-uglify')
-const replace = require('rollup-plugin-replace')
-const isProd = process.env.NODE_ENV === 'production'
-const version = process.env.VERSION || require('../package.json').version
-const chokidar = require('chokidar')
-const path = require('path')
+var rollup = require('rollup')
+var buble = require('rollup-plugin-buble')
+var commonjs = require('rollup-plugin-commonjs')
+var nodeResolve = require('rollup-plugin-node-resolve')
+var uglify = require('rollup-plugin-uglify')
+var isProd = process.argv[process.argv.length - 1] !== '--dev'
-const build = function (opts) {
+var build = function (opts) {
rollup
.rollup({
- input: opts.input,
- plugins: (opts.plugins || []).concat([
- buble(),
- commonjs(),
- nodeResolve(),
- replace({
- __VERSION__: version,
- 'process.env.SSR': false
- })
- ])
+ entry: 'src/' + opts.entry,
+ plugins: [buble()].concat(opts.plugins || [])
})
.then(function (bundle) {
- var dest = 'lib/' + (opts.output || opts.input)
+ var dest = 'lib/' + (opts.output || opts.entry)
console.log(dest)
bundle.write({
format: 'iife',
- file: dest,
- strict: false
+ moduleName: opts.moduleName || 'D',
+ dest: dest
})
})
.catch(function (err) {
console.error(err)
})
}
-const buildCore = function () {
- build({
- input: 'src/core/index.js',
- output: 'docsify.js'
- })
- if (isProd) {
- build({
- input: 'src/core/index.js',
- output: 'docsify.min.js',
- plugins: [uglify()]
- })
- }
-}
-const buildAllPlugin = function () {
- var plugins = [
- {name: 'search', input: 'search/index.js'},
- {name: 'ga', input: 'ga.js'},
- {name: 'matomo', input: 'matomo.js'},
- {name: 'emoji', input: 'emoji.js'},
- {name: 'external-script', input: 'external-script.js'},
- {name: 'front-matter', input: 'front-matter/index.js'},
- {name: 'zoom-image', input: 'zoom-image.js'},
- {name: 'disqus', input: 'disqus.js'},
- {name: 'gitalk', input: 'gitalk.js'}
- ]
-
- plugins.forEach(item => {
- build({
- input: 'src/plugins/' + item.input,
- output: 'plugins/' + item.name + '.js'
- })
- })
-
- if (isProd) {
- plugins.forEach(item => {
- build({
- input: 'src/plugins/' + item.input,
- output: 'plugins/' + item.name + '.min.js',
- plugins: [uglify()]
- })
- })
- }
-}
-
-if (!isProd) {
- chokidar
- .watch(['src/core', 'src/plugins'], {
- atomic: true,
- awaitWriteFinish: {
- stabilityThreshold: 1000,
- pollInterval: 100
- }
- })
- .on('change', p => {
- console.log('[watch] ', p)
- const dirs = p.split(path.sep)
- if (dirs[1] === 'core') {
- buildCore()
- } else if (dirs[2]) {
- const name = path.basename(dirs[2], '.js')
- const input = `src/plugins/${name}${
- /\.js/.test(dirs[2]) ? '' : '/index'
- }.js`
-
- build({
- input,
- output: 'plugins/' + name + '.js'
- })
- }
- })
- .on('ready', () => {
- console.log('[start]')
- buildCore()
- buildAllPlugin()
- })
-} else {
- buildCore()
- buildAllPlugin()
-}
+build({
+ entry: 'index.js',
+ output: 'docsify.js',
+ plugins: [commonjs(), nodeResolve()]
+})
+isProd && build({
+ entry: 'index.js',
+ output: 'docsify.min.js',
+ plugins: [commonjs(), nodeResolve(), uglify()]
+})
+build({
+ entry: 'plugins/search.js',
+ output: 'plugins/search.js',
+ moduleName: 'D.Search'
+})
+isProd && build({
+ entry: 'plugins/search.js',
+ output: 'plugins/search.min.js',
+ moduleName: 'D.Search',
+ plugins: [uglify()]
+})
+build({
+ entry: 'plugins/ga.js',
+ output: 'plugins/ga.js',
+ moduleName: 'D.GA'
+})
+isProd && build({
+ entry: 'plugins/ga.js',
+ output: 'plugins/ga.min.js',
+ moduleName: 'D.GA',
+ plugins: [uglify()]
+})
diff --git a/build/cover.js b/build/cover.js
deleted file mode 100644
index fbd27f7..0000000
--- a/build/cover.js
+++ /dev/null
@@ -1,14 +0,0 @@
-var fs = require('fs')
-var read = fs.readFileSync
-var write = fs.writeFileSync
-var version = process.env.VERSION || require('../package.json').version
-
-var file = __dirname + '/../docs/_coverpage.md'
-var cover = read(file, 'utf8').toString()
-
-console.log('Replace version number in cover page...')
-cover = cover.replace(
- /(\S+)?<\/small>/g,
- '' + version + ''
-)
-write(file, cover)
diff --git a/build/mincss.js b/build/mincss.js
deleted file mode 100644
index f6c5ec2..0000000
--- a/build/mincss.js
+++ /dev/null
@@ -1,12 +0,0 @@
-const cssnano = require('cssnano').process
-const path = require('path')
-const fs = require('fs')
-
-files = fs.readdirSync(path.resolve('lib/themes'))
-
-files.forEach(file => {
- file = path.resolve('lib/themes', file)
- cssnano(fs.readFileSync(file)).then(result => {
- fs.writeFileSync(file, result.css)
- })
-})
diff --git a/build/release.sh b/build/release.sh
deleted file mode 100755
index a328322..0000000
--- a/build/release.sh
+++ /dev/null
@@ -1,50 +0,0 @@
-set -e
-
-if [[ -z $1 ]]; then
- echo "Enter new version: "
- read VERSION
-else
- VERSION=$1
-fi
-
-read -p "Releasing $VERSION $RELEASE_TAG - are you sure? (y/n) " -n 1 -r
-echo
-if [[ $REPLY =~ ^[Yy]$ ]]; then
- echo "Releasing $VERSION ..."
-
- npm run test
-
- # build
- VERSION=$VERSION npm run build
-
- # update packages
- cd packages/docsify-server-renderer
- npm version $VERSION
- if [[ -z $RELEASE_TAG ]]; then
- npm publish
- else
- npm publish --tag $RELEASE_TAG
- fi
- cd -
-
- # commit
- git add -A
- git commit -m "[build] $VERSION $RELEASE_TAG"
- npm --no-git-tag-version version $VERSION --message "[release] $VERSION $RELEASE_TAG"
-
- # changelog
- node_modules/.bin/conventional-changelog -p angular -i CHANGELOG.md -s
-
- git add .
- git commit -m "chore: add changelog $VERSION"
-
- # publish
- git tag v$VERSION
- git push origin refs/tags/v$VERSION
- git push
- if [[ -z $RELEASE_TAG ]]; then
- npm publish
- else
- npm publish --tag $RELEASE_TAG
- fi
-fi
diff --git a/build/ssr.js b/build/ssr.js
deleted file mode 100644
index 16b93ca..0000000
--- a/build/ssr.js
+++ /dev/null
@@ -1,34 +0,0 @@
-var rollup = require('rollup')
-var buble = require('rollup-plugin-buble')
-var async = require('rollup-plugin-async')
-var replace = require('rollup-plugin-replace')
-
-rollup
- .rollup({
- input: 'packages/docsify-server-renderer/index.js',
- plugins: [
- async(),
- replace({
- __VERSION__: process.env.VERSION || require('../package.json').version,
- 'process.env.SSR': true
- }),
- buble({
- transforms: {
- generator: false
- }
- })
- ],
- onwarn: function () {}
- })
- .then(function (bundle) {
- var dest = 'packages/docsify-server-renderer/build.js'
-
- console.log(dest)
- bundle.write({
- format: 'cjs',
- file: dest
- })
- })
- .catch(function (err) {
- console.error(err)
- })
diff --git a/dev.html b/dev.html
new file mode 100644
index 0000000..54becd0
--- /dev/null
+++ b/dev.html
@@ -0,0 +1,34 @@
+
+
+
+
+ 
+ 