+
+
+### 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
new file mode 100644
index 0000000..fb720fd
--- /dev/null
+++ b/HISTORY.md
@@ -0,0 +1,736 @@
+
+
+## [3.7.3](https://github.com/QingWei-Li/docsify/compare/v3.7.2...v3.7.3) (2017-05-22)
+
+
+### Bug Fixes
+
+* **render:** find => filter ([eca3368](https://github.com/QingWei-Li/docsify/commit/eca3368))
+
+
+
+
+## [3.7.2](https://github.com/QingWei-Li/docsify/compare/v3.7.1...v3.7.2) (2017-05-19)
+
+
+
+
+## [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)
+
+
+### Features
+
+* 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))
+
+
+
+
+## [3.6.6](https://github.com/QingWei-Li/docsify/compare/v3.6.5...v3.6.6) (2017-05-06)
+
+
+### Features
+
+* 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))
+
+
+
+
+## [3.6.5](https://github.com/QingWei-Li/docsify/compare/v3.6.4...v3.6.5) (2017-04-28)
+
+
+### Bug Fixes
+
+* **util:** fix crash, fixed [#154](https://github.com/QingWei-Li/docsify/issues/154) ([51832d3](https://github.com/QingWei-Li/docsify/commit/51832d3))
+
+
+
+
+## [3.6.4](https://github.com/QingWei-Li/docsify/compare/v3.6.3...v3.6.4) (2017-04-28)
+
+
+### Bug Fixes
+
+* **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))
+
+
+
+
+## [3.6.3](https://github.com/QingWei-Li/docsify/compare/v3.6.2...v3.6.3) (2017-04-25)
+
+
+### Bug Fixes
+
+* **external-script:** script attrs ([2653849](https://github.com/QingWei-Li/docsify/commit/2653849))
+
+
+
+
+## [3.6.2](https://github.com/QingWei-Li/docsify/compare/v3.6.0...v3.6.2) (2017-04-12)
+
+
+### Features
+
+* **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))
+
+
+
+
+# [3.6.0](https://github.com/QingWei-Li/docsify/compare/v3.5.2...v3.6.0) (2017-04-09)
+
+
+### Features
+
+* **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))
+
+
+
+
+## [3.5.2](https://github.com/QingWei-Li/docsify/compare/v3.5.1...v3.5.2) (2017-04-05)
+
+
+
+
+## [3.5.1](https://github.com/QingWei-Li/docsify/compare/v3.5.0...v3.5.1) (2017-03-25)
+
+
+### Bug Fixes
+
+* .md file extension regex ([594299f](https://github.com/QingWei-Li/docsify/commit/594299f))
+
+
+
+
+# [3.5.0](https://github.com/QingWei-Li/docsify/compare/v3.4.4...v3.5.0) (2017-03-25)
+
+
+### Bug Fixes
+
+* 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))
+
+
+### Features
+
+* **route:** auto remove .md extension ([8f11653](https://github.com/QingWei-Li/docsify/commit/8f11653))
+
+
+
+
+## [3.4.4](https://github.com/QingWei-Li/docsify/compare/v3.4.3...v3.4.4) (2017-03-17)
+
+
+### 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)
diff --git a/LICENSE b/LICENSE
index 4808f79..37a4ac5 100644
--- a/LICENSE
+++ b/LICENSE
@@ -1,6 +1,6 @@
MIT License
-Copyright (c) 2016 cinwell.li
+Copyright (c) 2016 - present 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 70c0e1e..b8da0d8 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
@@ -9,52 +9,60 @@
- 
+ 
+ 
+ 
- 
+ 
+ 
+
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)
diff --git a/app.js b/app.js
deleted file mode 100644
index beada16..0000000
--- a/app.js
+++ /dev/null
@@ -1,12 +0,0 @@
-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
deleted file mode 100644
index 0890c29..0000000
--- a/build/build-css.js
+++ /dev/null
@@ -1,38 +0,0 @@
-var fs = require('fs')
-var cssnano = require('cssnano').process
-var resolve = require('path').resolve
-var postcss = require('postcss')
-
-var processor = postcss([require('postcss-salad')])
-
-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)
- 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 f8a6922..7b61224 100644
--- a/build/build.js
+++ b/build/build.js
@@ -1,37 +1,119 @@
-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')
+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 build = function (opts) {
+const build = function (opts) {
rollup
.rollup({
- entry: 'src/' + opts.entry,
- plugins: [buble()].concat(opts.plugins || [])
+ input: opts.input,
+ plugins: (opts.plugins || []).concat([
+ buble(),
+ commonjs(),
+ nodeResolve(),
+ replace({
+ __VERSION__: version,
+ 'process.env.SSR': false
+ })
+ ])
})
.then(function (bundle) {
- var dest = 'lib/' + (opts.output || opts.entry)
+ var dest = 'lib/' + (opts.output || opts.input)
console.log(dest)
bundle.write({
format: 'iife',
- moduleName: opts.moduleName || 'Docsify',
- dest: dest
+ file: dest,
+ strict: false
})
})
.catch(function (err) {
console.error(err)
})
}
+const buildCore = function () {
+ build({
+ input: 'src/core/index.js',
+ output: 'docsify.js'
+ })
-build({
- entry: 'index.js',
- output: 'docsify.js',
- plugins: [commonjs(), nodeResolve()]
-})
-build({
- entry: 'index.js',
- output: 'docsify.min.js',
- plugins: [commonjs(), nodeResolve(), uglify()]
-})
+ 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()
+}
diff --git a/build/cover.js b/build/cover.js
new file mode 100644
index 0000000..fbd27f7
--- /dev/null
+++ b/build/cover.js
@@ -0,0 +1,14 @@
+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
new file mode 100644
index 0000000..f6c5ec2
--- /dev/null
+++ b/build/mincss.js
@@ -0,0 +1,12 @@
+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
new file mode 100755
index 0000000..a328322
--- /dev/null
+++ b/build/release.sh
@@ -0,0 +1,50 @@
+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
new file mode 100644
index 0000000..16b93ca
--- /dev/null
+++ b/build/ssr.js
@@ -0,0 +1,34 @@
+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
deleted file mode 100644
index 7edecde..0000000
--- a/dev.html
+++ /dev/null
@@ -1,14 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/docs/README.md b/docs/README.md
index 8a2b674..e625420 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,311 +1,32 @@
-## Quick Start
-
-### Create a project
-First create a project, then create a `docs` folder
-```shell
-mkdir my-project && cd my-project
-mkdir docs && cd docs
-```
-
-### Create entry file
-Create a `index.html` file
-
-```html
-
-
-
-
-
-
-
-
-
-
-
-```
-
-Create `README.md` as the main page
-
-```
-# Title
-
-## blabla
-```
-
-### Deploy!
-Push and open the **GitHub Pages** feature
-
-
-## CLI
-
-Easy to setup and preview a docs.
-
-### Install
-```shell
-npm i docsify-cli -g
-```
-
-### Setup
-
-Setup a boilerplate docs
-```shell
-docsify init docs
-```
-
-### Preview
-Preview and serve your docs using
-```shell
-docsify serve docs
-```
-
-Read more [docsify-cli](https://github.com/QingWei-Li/docsify-cli)
-
-## Themes
-Currently available `vue.css` and `buble.css`
-```html
-
-
-```
-
-Minified files
-
-```html
-
-
-```
-
-## More
-
-### Multiple pages
-If you need other pages, directly create the markdown file, such as `guide.md` is `/#/guide`.
-
-### Navbar
-Code in `index.html`
-
-```html
-
-```
-
-### CDN
-- UNPKG [https://unpkg.com/docsify/](https://unpkg.com/docsify/)
-- jsDelivr [http://www.jsdelivr.com/projects/docsify](http://www.jsdelivr.com/projects/docsify)
-
-
-### Cover Page
-
-Generate a cover page through with markdown. Create a `_coverpage.md` and set `data-coverpage` in script tag.
-
-```markdown
-
-
-# docsify 1.2.0
+## docsify
> A magical documentation site generator.
-- Simple and lightweight (~12kb gzipped)
+## What it is
+
+docsify generates your documentation website on the fly. Unlike GitBook, it does not generate static html files. Instead, it smartly loads and parses your Markdown files and displays them as a website. To start using it, all you need to do is create an `index.html` and [deploy it on GitHub Pages](deploy.md).
+
+See the [Quick start](quickstart.md) guide for more details.
+
+## Features
+
+- No statically built html files
+- Simple and lightweight (~21kB gzipped)
+- Smart full-text search plugin
- Multiple themes
-- Not build static html files
+- Useful plugin API
+- Emoji support
+- Compatible with IE11
+- Support server-side rendering ([example](https://github.com/docsifyjs/docsify-ssr-demo))
+## Examples
-[GitHub](https://github.com/QingWei-Li/docsify/)
-[Get Started](#quick-start)
-```
+Check out the [Showcase](https://github.com/docsifyjs/awesome-docsify#showcase) to see docsify in use.
-#### Custom background
-Currently the background of cover page is generated randomly. We can customize the background, just using the syntax to add image.
+## Donate
-```markdown
-# docsify 1.2.0
+Please consider donating if you think docsify is helpful to you or that my work is valuable. I am happy if you can help me [buy a cup of coffee](https://github.com/QingWei-Li/donate). :heart:
-> xxx
+## Community
-[GitHub](https://github.com/QingWei-Li/docsify/)
-[Get Started](#quick-start)
-
-
-
-
-
-```
-
-
-### Options
-
-#### repo
-Display the [GitHub Corner](http://tholman.com/github-corners/) widget.
-
-```html
-
-```
-
-#### max-level
-TOC level.
-
-```html
-
-```
-
-#### el
-Root element.
-
-```html
-
-```
-
-#### sidebar-toggle
-
-Sidebar with toggle
-
-```html
-
-```
-
-#### sidebar
-
-Custom sidebar. If it's set, the TOC will be disabled. Bind global variables on the `data-sidebar`.
-
-
-
-```html
-
-
-```
-
-
-#### load-sidebar
-
-Load sidebar markdown file. If it is configured, load the current directory `_sidebar.md` by default. If the file isn't exist, sidebar will appear as a TOC.
-** you should add `.nojekyll` into docs folder to prevent GitHub Pages from ignoring the `_sidebar.md`**
-
-```html
-
-```
-
-You can specify a file:
-
-```html
-
-```
-
-The contents of the file can be:
-
-```markdown
-- [Home](/)
-- [Installation](/installation)
-- Essentials
- - [Getting Started](/getting-started)
- - [Dynamic Route Matching](/dynamic-matching)
- - [Nested Routes](/nested-routes)
- - [Programmatic Navigation](/navigation)
- - [Named Routes](/named-routes)
- - [Named Views](/named-views)
- - [Redirect and Alias](/redirect-and-alias)
- - [HTML5 History Mode](/history-mode)
-```
-
-#### sub-max-level
-
-Display TOC in the custom sidebar. The default value is 0.
-
-
-```html
-
-```
-
-
-
-
-#### load-navbar
-
-Load navbar markdown file. If it is configured, load the current directory `_navbar.md` by default.
-
-```html
-
-```
-
-You can specify a file:
-
-```html
-
-```
-
-The contents of the file can be:
-
-```markdown
-- [en](/)
-- [chinese](/zh-cn)
-```
-
-If you write a sub level list, it will generate a dropdown list.
-
-```markdown
-- [download](/download)
-- language
- - [en](/)
- - [chinese](/zh-cn)
-```
-
-#### router
-
-Hash router.
-
-```html
-
-```
-
-#### auto2top
-
-Scroll to the top on changing hash.
-
-
-```html
-
-```
-
-#### homepage
-
-`README.md` will be rendered as a homepage for your website in the docs folder, but sometimes we want to specify another file as a homepage, or even use the `README.md` in your repo. We can use (need `data-router`):
-
-```html
-
-
-
-```
-
-
-#### basePath
-
-If your HTML entry file and the markdown files are in different directories, we can use:
-
-```html
-
-
-
-
-```
-
-
-#### coverpage
-
-Generate cover page.
-
-```html
-
-
-
-```
\ No newline at end of file
+Users and the development team are usually in the [Gitter chat room](https://gitter.im/docsifyjs/Lobby).
diff --git a/docs/_coverpage.md b/docs/_coverpage.md
index 92ba592..1decbd6 100644
--- a/docs/_coverpage.md
+++ b/docs/_coverpage.md
@@ -1,13 +1,12 @@
-# docsify 1.3.3
+# docsify 4.9.4
> A magical documentation site generator.
-- Simple and lightweight (~12kb gzipped)
+- Simple and lightweight (~21kB gzipped)
+- No statically built html files
- Multiple themes
-- Not build static html files
-
-[GitHub](https://github.com/QingWei-Li/docsify/)
-[Get Started](#quick-start)
+[GitHub](https://github.com/docsifyjs/docsify/)
+[Getting Started](#docsify)
diff --git a/docs/_images/deploy-github-pages.png b/docs/_images/deploy-github-pages.png
new file mode 100644
index 0000000..278e40b
Binary files /dev/null and b/docs/_images/deploy-github-pages.png differ
diff --git a/docs/_images/nested-navbar.png b/docs/_images/nested-navbar.png
new file mode 100644
index 0000000..25f2341
Binary files /dev/null and b/docs/_images/nested-navbar.png differ
diff --git a/docs/_images/zh-cn/nested-navbar.png b/docs/_images/zh-cn/nested-navbar.png
new file mode 100644
index 0000000..0b2a1c9
Binary files /dev/null and b/docs/_images/zh-cn/nested-navbar.png differ
diff --git a/docs/_media/example.html b/docs/_media/example.html
new file mode 100644
index 0000000..d35ee16
--- /dev/null
+++ b/docs/_media/example.html
@@ -0,0 +1 @@
+
+ 
'
- + (escaped ? code : escape(code, true))
- + '\n'
- + (escaped ? code : escape(code, true))
- + '\n\n' + quote + '\n'; -}; - -Renderer.prototype.html = function(html) { - return html; -}; - -Renderer.prototype.heading = function(text, level, raw) { - return '
' + text + '
\n'; -}; - -Renderer.prototype.table = function(header, body) { - return '' + text + '';
-};
-
-Renderer.prototype.br = function() {
- return this.options.xhtml ? 'An error occured:
' - + escape(e.message + '', true) - + ''; - } - throw e; - } -} - -/** - * Options - */ - -marked.options = -marked.setOptions = function(opt) { - merge(marked.defaults, opt); - return marked; -}; - -marked.defaults = { - gfm: true, - tables: true, - breaks: false, - pedantic: false, - sanitize: false, - sanitizer: null, - mangle: true, - smartLists: false, - silent: false, - highlight: null, - langPrefix: 'lang-', - smartypants: false, - headerPrefix: '', - renderer: new Renderer, - xhtml: false -}; - -/** - * Expose - */ - -marked.Parser = Parser; -marked.parser = Parser.parse; - -marked.Renderer = Renderer; - -marked.Lexer = Lexer; -marked.lexer = Lexer.lex; - -marked.InlineLexer = InlineLexer; -marked.inlineLexer = InlineLexer.output; - -marked.parse = marked; - -if (typeof module !== 'undefined' && typeof exports === 'object') { - module.exports = marked; -} else if (typeof define === 'function' && define.amd) { - define(function() { return marked; }); -} else { - this.marked = marked; -} - -}).call(function() { - return this || (typeof window !== 'undefined' ? window : commonjsGlobal); -}()); -}); - -var prism = createCommonjsModule(function (module) { -/* ********************************************** - Begin prism-core.js -********************************************** */ - -var _self = (typeof window !== 'undefined') - ? window // if in browser - : ( - (typeof WorkerGlobalScope !== 'undefined' && self instanceof WorkerGlobalScope) - ? self // if in worker - : {} // if in node js - ); - -/** - * Prism: Lightweight, robust, elegant syntax highlighting - * MIT license http://www.opensource.org/licenses/mit-license.php/ - * @author Lea Verou http://lea.verou.me - */ - -var Prism = (function(){ - -// Private helper vars -var lang = /\blang(?:uage)?-(\w+)\b/i; -var uniqueId = 0; - -var _ = _self.Prism = { - util: { - encode: function (tokens) { - if (tokens instanceof Token) { - return new Token(tokens.type, _.util.encode(tokens.content), tokens.alias); - } else if (_.util.type(tokens) === 'Array') { - return tokens.map(_.util.encode); - } else { - return tokens.replace(/&/g, '&').replace(/ text.length) { - // Something went terribly wrong, ABORT, ABORT! - break tokenloop; - } - - if (str instanceof Token) { - continue; - } - - pattern.lastIndex = 0; - - var match = pattern.exec(str), - delNum = 1; - - // Greedy patterns can override/remove up to two previously matched tokens - if (!match && greedy && i != strarr.length - 1) { - // Reconstruct the original text using the next two tokens - var nextToken = strarr[i + 1].matchedStr || strarr[i + 1], - combStr = str + nextToken; - - if (i < strarr.length - 2) { - combStr += strarr[i + 2].matchedStr || strarr[i + 2]; - } - - // Try the pattern again on the reconstructed text - pattern.lastIndex = 0; - match = pattern.exec(combStr); - if (!match) { - continue; - } - - var from = match.index + (lookbehind ? match[1].length : 0); - // To be a valid candidate, the new match has to start inside of str - if (from >= str.length) { - continue; - } - var to = match.index + match[0].length, - len = str.length + nextToken.length; - - // Number of tokens to delete and replace with the new match - delNum = 3; - - if (to <= len) { - if (strarr[i + 1].greedy) { - continue; - } - delNum = 2; - combStr = combStr.slice(0, len); - } - str = combStr; - } - - if (!match) { - continue; - } - - if(lookbehind) { - lookbehindLength = match[1].length; - } - - var from = match.index + lookbehindLength, - match = match[0].slice(lookbehindLength), - to = from + match.length, - before = str.slice(0, from), - after = str.slice(to); - - var args = [i, delNum]; - - if (before) { - args.push(before); - } - - var wrapped = new Token(token, inside? _.tokenize(match, inside) : match, alias, match, greedy); - - args.push(wrapped); - - if (after) { - args.push(after); - } - - Array.prototype.splice.apply(strarr, args); - } - } - } - - return strarr; - }, - - hooks: { - all: {}, - - add: function (name, callback) { - var hooks = _.hooks.all; - - hooks[name] = hooks[name] || []; - - hooks[name].push(callback); - }, - - run: function (name, env) { - var callbacks = _.hooks.all[name]; - - if (!callbacks || !callbacks.length) { - return; - } - - for (var i=0, callback; callback = callbacks[i++];) { - callback(env); - } - } - } -}; - -var Token = _.Token = function(type, content, alias, matchedStr, greedy) { - this.type = type; - this.content = content; - this.alias = alias; - // Copy of the full string this token was created from - this.matchedStr = matchedStr || null; - this.greedy = !!greedy; -}; - -Token.stringify = function(o, language, parent) { - if (typeof o == 'string') { - return o; - } - - if (_.util.type(o) === 'Array') { - return o.map(function(element) { - return Token.stringify(element, language, o); - }).join(''); - } - - var env = { - type: o.type, - content: Token.stringify(o.content, language, parent), - tag: 'span', - classes: ['token', o.type], - attributes: {}, - language: language, - parent: parent - }; - - if (env.type == 'comment') { - env.attributes['spellcheck'] = 'true'; - } - - if (o.alias) { - var aliases = _.util.type(o.alias) === 'Array' ? o.alias : [o.alias]; - Array.prototype.push.apply(env.classes, aliases); - } - - _.hooks.run('wrap', env); - - var attributes = ''; - - for (var name in env.attributes) { - attributes += (attributes ? ' ' : '') + name + '="' + (env.attributes[name] || '') + '"'; - } - - return '<' + env.tag + ' class="' + env.classes.join(' ') + '" ' + attributes + '>' + env.content + ''; - -}; - -if (!_self.document) { - if (!_self.addEventListener) { - // in Node.js - return _self.Prism; - } - // In worker - _self.addEventListener('message', function(evt) { - var message = JSON.parse(evt.data), - lang = message.language, - code = message.code, - immediateClose = message.immediateClose; - - _self.postMessage(_.highlight(code, _.languages[lang], lang)); - if (immediateClose) { - _self.close(); - } - }, false); - - return _self.Prism; -} - -//Get current script and highlight -var script = document.currentScript || [].slice.call(document.getElementsByTagName("script")).pop(); - -if (script) { - _.filename = script.src; - - if (document.addEventListener && !script.hasAttribute('data-manual')) { - if(document.readyState !== "loading") { - requestAnimationFrame(_.highlightAll, 0); - } - else { - document.addEventListener('DOMContentLoaded', _.highlightAll); - } - } -} - -return _self.Prism; - -})(); - -if (typeof module !== 'undefined' && module.exports) { - module.exports = Prism; -} - -// hack for components to work correctly in node.js -if (typeof commonjsGlobal !== 'undefined') { - commonjsGlobal.Prism = Prism; -} - - -/* ********************************************** - Begin prism-markup.js -********************************************** */ - -Prism.languages.markup = { - 'comment': //, - 'prolog': /<\?[\w\W]+?\?>/, - 'doctype': //, - 'cdata': //i, - 'tag': { - pattern: /<\/?(?!\d)[^\s>\/=.$<]+(?:\s+[^\s>\/=]+(?:=(?:("|')(?:\\\1|\\?(?!\1)[\w\W])*\1|[^\s'">=]+))?)*\s*\/?>/i, - inside: { - 'tag': { - pattern: /^<\/?[^\s>\/]+/i, - inside: { - 'punctuation': /^<\/?/, - 'namespace': /^[^\s>\/:]+:/ - } - }, - 'attr-value': { - pattern: /=(?:('|")[\w\W]*?(\1)|[^\s>]+)/i, - inside: { - 'punctuation': /[=>"']/ - } - }, - 'punctuation': /\/?>/, - 'attr-name': { - pattern: /[^\s>\/]+/, - inside: { - 'namespace': /^[^\s>\/:]+:/ - } - } - - } - }, - 'entity': /&#?[\da-z]{1,8};/i -}; - -// Plugin to make entity title show the real entity, idea by Roman Komarov -Prism.hooks.add('wrap', function(env) { - - if (env.type === 'entity') { - env.attributes['title'] = env.content.replace(/&/, '&'); - } -}); - -Prism.languages.xml = Prism.languages.markup; -Prism.languages.html = Prism.languages.markup; -Prism.languages.mathml = Prism.languages.markup; -Prism.languages.svg = Prism.languages.markup; - - -/* ********************************************** - Begin prism-css.js -********************************************** */ - -Prism.languages.css = { - 'comment': /\/\*[\w\W]*?\*\//, - 'atrule': { - pattern: /@[\w-]+?.*?(;|(?=\s*\{))/i, - inside: { - 'rule': /@[\w-]+/ - // See rest below - } - }, - 'url': /url\((?:(["'])(\\(?:\r\n|[\w\W])|(?!\1)[^\\\r\n])*\1|.*?)\)/i, - 'selector': /[^\{\}\s][^\{\};]*?(?=\s*\{)/, - 'string': /("|')(\\(?:\r\n|[\w\W])|(?!\1)[^\\\r\n])*\1/, - 'property': /(\b|\B)[\w-]+(?=\s*:)/i, - 'important': /\B!important\b/i, - 'function': /[-a-z0-9]+(?=\()/i, - 'punctuation': /[(){};:]/ -}; - -Prism.languages.css['atrule'].inside.rest = Prism.util.clone(Prism.languages.css); - -if (Prism.languages.markup) { - Prism.languages.insertBefore('markup', 'tag', { - 'style': { - pattern: /(
" + hl + ""+s(e.message+"",!0)+"";throw e}}var d={newline:/^\n+/,code:/^( {4}[^\n]+\n*)+/,fences:u,hr:/^( *[-*_]){3,} *(?:\n+|$)/,heading:/^ *(#{1,6}) *([^\n]+?) *#* *(?:\n+|$)/,nptable:u,lheading:/^([^\n]+)\n *(=|-){2,} *(?:\n+|$)/,blockquote:/^( *>[^\n]+(\n(?!def)[^\n]+)*\n*)+/,list:/^( *)(bull) [\s\S]+?(?:hr|def|\n{2,}(?! )(?!\1bull )\n*|\s*$)/,html:/^ *(?:comment *(?:\n|\s*$)|closed *(?:\n{2,}|\s*$)|closing *(?:\n{2,}|\s*$))/,def:/^ *\[([^\]]+)\]: *]+)>?(?: +["(]([^\n]+)[")])? *(?:\n+|$)/,table:u,paragraph:/^((?:[^\n]+\n?(?!hr|heading|lheading|blockquote|tag|def))+)\n*/,text:/^[^\n]+/};d.bullet=/(?:[*+-]|\d+\.)/,d.item=/^( *)(bull) [^\n]*(?:\n(?!\1bull )[^\n]*)*/,d.item=l(d.item,"gm")(/bull/g,d.bullet)(),d.list=l(d.list)(/bull/g,d.bullet)("hr","\\n+(?=\\1?(?:[-*_] *){3,}(?:\\n+|$))")("def","\\n+(?="+d.def.source+")")(),d.blockquote=l(d.blockquote)("def",d.def)(),d._tag="(?!(?:a|em|strong|small|s|cite|q|dfn|abbr|data|time|code|var|samp|kbd|sub|sup|i|b|u|mark|ruby|rt|rp|bdi|bdo|span|br|wbr|ins|del|img)\\b)\\w+(?!:/|[^\\w\\s@]*@)\\b",d.html=l(d.html)("comment",//)("closed",/<(tag)[\s\S]+?<\/\1>/)("closing",/
'+(n?e:s(e,!0))+"\n"+(n?e:s(e,!0))+"\n\n"+e+"\n"},a.prototype.html=function(e){return e},a.prototype.heading=function(e,t,n){return"
"+e+"
\n"},a.prototype.table=function(e,t){return""+e+""},a.prototype.br=function(){return this.options.xhtml?"'+n+"${hl}${text}
` + } + return result + } + origin.image = renderer.image = function (href, title, text) { + let url = href + let attrs = '' + + const {str, config} = getAndRemoveConfig(title) + title = str + + if (config['no-zoom']) { + attrs += ' data-no-zoom' + } + + if (title) { + attrs += ` title="${title}"` + } + + const size = config.size + if (size) { + const sizes = size.split('x') + if (sizes[1]) { + attrs += 'width=' + sizes[0] + ' height=' + sizes[1] + } else { + attrs += 'width=' + sizes[0] + } + } + + if (!isAbsolutePath(href)) { + url = getPath(contentBase, getParentPath(router.getCurrentPath()), href) + } + + return `
'
+}
+
+export function emojify(text) {
+ return text
+ .replace(/<(pre|template|code)[^>]*?>[\s\S]+?<\/(pre|template|code)>/g, m => m.replace(/:/g, '__colon__'))
+ .replace(/:(\w+?):/ig, (inBrowser && window.emojify) || replace)
+ .replace(/__colon__/g, ':')
+}
diff --git a/src/core/render/gen-tree.js b/src/core/render/gen-tree.js
new file mode 100644
index 0000000..81ba4bd
--- /dev/null
+++ b/src/core/render/gen-tree.js
@@ -0,0 +1,28 @@
+/**
+ * Gen toc tree
+ * @link https://github.com/killercup/grock/blob/5280ae63e16c5739e9233d9009bc235ed7d79a50/styles/solarized/assets/js/behavior.coffee#L54-L81
+ * @param {Array} toc
+ * @param {Number} maxLevel
+ * @return {Array}
+ */
+export function genTree(toc, maxLevel) {
+ const headlines = []
+ const last = {}
+
+ toc.forEach(headline => {
+ const level = headline.level || 1
+ const len = level - 1
+
+ if (level > maxLevel) {
+ return
+ }
+ if (last[len]) {
+ last[len].children = (last[len].children || []).concat(headline)
+ } else {
+ headlines.push(headline)
+ }
+ last[level] = headline
+ })
+
+ return headlines
+}
diff --git a/src/core/render/index.js b/src/core/render/index.js
new file mode 100644
index 0000000..fae1bc5
--- /dev/null
+++ b/src/core/render/index.js
@@ -0,0 +1,276 @@
+import * as dom from '../util/dom'
+import * as tpl from './tpl'
+import cssVars from '../util/polyfill/css-vars'
+import tinydate from 'tinydate'
+import {callHook} from '../init/lifecycle'
+import {Compiler} from './compiler'
+import {getAndActive, sticky} from '../event/sidebar'
+import {getPath, isAbsolutePath} from '../router/util'
+import {isMobile, inBrowser} from '../util/env'
+import {isPrimitive} from '../util/core'
+import {scrollActiveSidebar, scroll2Top} from '../event/scroll'
+import {prerenderEmbed} from './embed'
+
+function executeScript() {
+ const script = dom
+ .findAll('.markdown-section>script')
+ .filter(s => !/template/.test(s.type))[0]
+ if (!script) {
+ return false
+ }
+ const code = script.innerText.trim()
+ if (!code) {
+ return false
+ }
+
+ setTimeout(_ => {
+ window.__EXECUTE_RESULT__ = new Function(code)()
+ }, 0)
+}
+
+function formatUpdated(html, updated, fn) {
+ updated =
+ typeof fn === 'function' ?
+ fn(updated) :
+ typeof fn === 'string' ?
+ tinydate(fn)(new Date(updated)) :
+ updated
+
+ return html.replace(/{docsify-updated}/g, updated)
+}
+
+function renderMain(html) {
+ if (!html) {
+ html = '${content.slice(5).trim()}
` +} + +export function theme(color) { + return `` +} diff --git a/src/core/router/history/abstract.js b/src/core/router/history/abstract.js new file mode 100644 index 0000000..2c0bd95 --- /dev/null +++ b/src/core/router/history/abstract.js @@ -0,0 +1,25 @@ +import {History} from './base' +import {parseQuery} from '../util' + +export class AbstractHistory extends History { + constructor(config) { + super(config) + this.mode = 'abstract' + } + + parse(path) { + let query = '' + + const queryIndex = path.indexOf('?') + if (queryIndex >= 0) { + query = path.slice(queryIndex + 1) + path = path.slice(0, queryIndex) + } + + return { + path, + file: this.getFile(path), + query: parseQuery(query) + } + } +} diff --git a/src/core/router/history/base.js b/src/core/router/history/base.js new file mode 100644 index 0000000..7ea763d --- /dev/null +++ b/src/core/router/history/base.js @@ -0,0 +1,86 @@ +import { + getPath, + isAbsolutePath, + stringifyQuery, + cleanPath, + replaceSlug, + resolvePath +} from '../util' +import {noop, merge} from '../../util/core' + +const cached = {} + +function getAlias(path, alias, last) { + const match = Object.keys(alias).filter(key => { + const re = cached[key] || (cached[key] = new RegExp(`^${key}$`)) + return re.test(path) && path !== last + })[0] + + return match ? + getAlias(path.replace(cached[match], alias[match]), alias, path) : + path +} + +function getFileName(path, ext) { + return new RegExp(`\\.(${ext.replace(/^\./, '')}|html)$`, 'g').test(path) ? + path : + /\/$/g.test(path) ? `${path}README${ext}` : `${path}${ext}` +} + +export class History { + constructor(config) { + this.config = config + } + + getBasePath() { + return this.config.basePath + } + + getFile(path = this.getCurrentPath(), isRelative) { + const {config} = this + const base = this.getBasePath() + const ext = typeof config.ext === 'string' ? config.ext : '.md' + + path = config.alias ? getAlias(path, config.alias) : path + path = getFileName(path, ext) + path = path === `/README${ext}` ? config.homepage || path : path + path = isAbsolutePath(path) ? path : getPath(base, path) + + if (isRelative) { + path = path.replace(new RegExp(`^${base}`), '') + } + + return path + } + + onchange(cb = noop) { + cb() + } + + getCurrentPath() {} + + normalize() {} + + parse() {} + + toURL(path, params, currentRoute) { + const local = currentRoute && path[0] === '#' + const route = this.parse(replaceSlug(path)) + + route.query = merge({}, route.query, params) + path = route.path + stringifyQuery(route.query) + path = path.replace(/\.md(\?)|\.md$/, '$1') + + if (local) { + const idIndex = currentRoute.indexOf('?') + path = + (idIndex > 0 ? currentRoute.substring(0, idIndex) : currentRoute) + path + } + + if (this.config.relativePath && path.indexOf('/') !== 0) { + const currentDir = currentRoute.substring(0, currentRoute.lastIndexOf('/') + 1) + return cleanPath(resolvePath(currentDir + path)) + } + return cleanPath('/' + path) + } +} diff --git a/src/core/router/history/hash.js b/src/core/router/history/hash.js new file mode 100644 index 0000000..2674d5d --- /dev/null +++ b/src/core/router/history/hash.js @@ -0,0 +1,76 @@ +import {History} from './base' +import {noop} from '../../util/core' +import {on} from '../../util/dom' +import {parseQuery, cleanPath, replaceSlug} from '../util' + +function replaceHash(path) { + const i = location.href.indexOf('#') + location.replace(location.href.slice(0, i >= 0 ? i : 0) + '#' + path) +} + +export class HashHistory extends History { + constructor(config) { + super(config) + this.mode = 'hash' + } + + getBasePath() { + const path = window.location.pathname || '' + const base = this.config.basePath + + return /^(\/|https?:)/g.test(base) ? base : cleanPath(path + '/' + base) + } + + getCurrentPath() { + // We can't use location.hash here because it's not + // consistent across browsers - Firefox will pre-decode it! + const href = location.href + const index = href.indexOf('#') + return index === -1 ? '' : href.slice(index + 1) + } + + onchange(cb = noop) { + on('hashchange', cb) + } + + normalize() { + let path = this.getCurrentPath() + + path = replaceSlug(path) + + if (path.charAt(0) === '/') { + return replaceHash(path) + } + replaceHash('/' + path) + } + + /** + * Parse the url + * @param {string} [path=location.herf] + * @return {object} { path, query } + */ + parse(path = location.href) { + let query = '' + + const hashIndex = path.indexOf('#') + if (hashIndex >= 0) { + path = path.slice(hashIndex + 1) + } + + const queryIndex = path.indexOf('?') + if (queryIndex >= 0) { + query = path.slice(queryIndex + 1) + path = path.slice(0, queryIndex) + } + + return { + path, + file: this.getFile(path, true), + query: parseQuery(query) + } + } + + toURL(path, params, currentRoute) { + return '#' + super.toURL(path, params, currentRoute) + } +} diff --git a/src/core/router/history/html5.js b/src/core/router/history/html5.js new file mode 100644 index 0000000..04c5391 --- /dev/null +++ b/src/core/router/history/html5.js @@ -0,0 +1,65 @@ +import {History} from './base' +import {noop} from '../../util/core' +import {on} from '../../util/dom' +import {parseQuery, getPath} from '../util' + +export class HTML5History extends History { + constructor(config) { + super(config) + this.mode = 'history' + } + + getCurrentPath() { + const base = this.getBasePath() + let path = window.location.pathname + + if (base && path.indexOf(base) === 0) { + path = path.slice(base.length) + } + + return (path || '/') + window.location.search + window.location.hash + } + + onchange(cb = noop) { + on('click', e => { + const el = e.target.tagName === 'A' ? e.target : e.target.parentNode + + if (el.tagName === 'A' && !/_blank/.test(el.target)) { + e.preventDefault() + const url = el.href + window.history.pushState({key: url}, '', url) + cb() + } + }) + + on('popstate', cb) + } + + /** + * Parse the url + * @param {string} [path=location.href] + * @return {object} { path, query } + */ + parse(path = location.href) { + let query = '' + + const queryIndex = path.indexOf('?') + if (queryIndex >= 0) { + query = path.slice(queryIndex + 1) + path = path.slice(0, queryIndex) + } + + const base = getPath(location.origin) + const baseIndex = path.indexOf(base) + + if (baseIndex > -1) { + path = path.slice(baseIndex + base.length) + } + + return { + path, + file: this.getFile(path), + query: parseQuery(query) + } + } +} diff --git a/src/core/router/index.js b/src/core/router/index.js new file mode 100644 index 0000000..943fe6c --- /dev/null +++ b/src/core/router/index.js @@ -0,0 +1,45 @@ +import {HashHistory} from './history/hash' +import {HTML5History} from './history/html5' +import {supportsPushState} from '../util/env' +import * as dom from '../util/dom' + +export function routerMixin(proto) { + proto.route = {} +} + +let lastRoute = {} + +function updateRender(vm) { + vm.router.normalize() + vm.route = vm.router.parse() + dom.body.setAttribute('data-page', vm.route.file) +} + +export function initRouter(vm) { + const config = vm.config + const mode = config.routerMode || 'hash' + let router + + if (mode === 'history' && supportsPushState) { + router = new HTML5History(config) + } else { + router = new HashHistory(config) + } + + vm.router = router + updateRender(vm) + lastRoute = vm.route + + router.onchange(_ => { + updateRender(vm) + vm._updateRender() + + if (lastRoute.path === vm.route.path) { + vm.$resetEvents() + return + } + + vm.$fetch() + lastRoute = vm.route + }) +} diff --git a/src/core/router/util.js b/src/core/router/util.js new file mode 100644 index 0000000..2ed88c5 --- /dev/null +++ b/src/core/router/util.js @@ -0,0 +1,76 @@ +import {cached} from '../util/core' + +const decode = decodeURIComponent +const encode = encodeURIComponent + +export function parseQuery(query) { + const res = {} + + query = query.trim().replace(/^(\?|#|&)/, '') + + if (!query) { + return res + } + + // Simple parse + query.split('&').forEach(function (param) { + const parts = param.replace(/\+/g, ' ').split('=') + + res[parts[0]] = parts[1] && decode(parts[1]) + }) + + return res +} + +export function stringifyQuery(obj, ignores = []) { + const qs = [] + + for (const key in obj) { + if (ignores.indexOf(key) > -1) { + continue + } + qs.push( + obj[key] ? + `${encode(key)}=${encode(obj[key])}`.toLowerCase() : + encode(key) + ) + } + + return qs.length ? `?${qs.join('&')}` : '' +} + +export const isAbsolutePath = cached(path => { + return /(:|(\/{2}))/g.test(path) +}) + +export const getParentPath = cached(path => { + return /\/$/g.test(path) ? + path : + (path = path.match(/(\S*\/)[^/]+$/)) ? path[1] : '' +}) + +export const cleanPath = cached(path => { + return path.replace(/^\/+/, '/').replace(/([^:])\/{2,}/g, '$1/') +}) + +export const resolvePath = cached(path => { + const segments = path.replace(/^\//, '').split('/') + let resolved = [] + for (let i = 0, len = segments.length; i < len; i++) { + const segment = segments[i] + if (segment === '..') { + resolved.pop() + } else if (segment !== '.') { + resolved.push(segment) + } + } + return '/' + resolved.join('/') +}) + +export function getPath(...args) { + return cleanPath(args.join('/')) +} + +export const replaceSlug = cached(path => { + return path.replace('#', '?id=') +}) diff --git a/src/core/util/core.js b/src/core/util/core.js new file mode 100644 index 0000000..a94472d --- /dev/null +++ b/src/core/util/core.js @@ -0,0 +1,58 @@ +/** + * Create a cached version of a pure function. + */ +export function cached(fn) { + const cache = Object.create(null) + return function (str) { + const key = isPrimitive(str) ? str : JSON.stringify(str) + const hit = cache[key] + return hit || (cache[key] = fn(str)) + } +} + +/** + * Hyphenate a camelCase string. + */ +export const hyphenate = cached(str => { + return str.replace(/([A-Z])/g, m => '-' + m.toLowerCase()) +}) + +export const hasOwn = Object.prototype.hasOwnProperty + +/** + * Simple Object.assign polyfill + */ +export const merge = + Object.assign || + function (to) { + for (let i = 1; i < arguments.length; i++) { + const from = Object(arguments[i]) + + for (const key in from) { + if (hasOwn.call(from, key)) { + to[key] = from[key] + } + } + } + + return to + } + +/** + * Check if value is primitive + */ +export function isPrimitive(value) { + return typeof value === 'string' || typeof value === 'number' +} + +/** + * Perform no operation. + */ +export function noop() {} + +/** + * Check if value is function + */ +export function isFn(obj) { + return typeof obj === 'function' +} diff --git a/src/core/util/dom.js b/src/core/util/dom.js new file mode 100644 index 0000000..388927d --- /dev/null +++ b/src/core/util/dom.js @@ -0,0 +1,92 @@ +import {isFn} from '../util/core' +import {inBrowser} from './env' + +const cacheNode = {} + +/** + * Get Node + * @param {String|Element} el + * @param {Boolean} noCache + * @return {Element} + */ +export function getNode(el, noCache = false) { + if (typeof el === 'string') { + if (typeof window.Vue !== 'undefined') { + return find(el) + } + el = noCache ? find(el) : cacheNode[el] || (cacheNode[el] = find(el)) + } + + return el +} + +export const $ = inBrowser && document + +export const body = inBrowser && $.body + +export const head = inBrowser && $.head + +/** + * Find element + * @example + * find('nav') => document.querySelector('nav') + * find(nav, 'a') => nav.querySelector('a') + */ +export function find(el, node) { + return node ? el.querySelector(node) : $.querySelector(el) +} + +/** + * Find all elements + * @example + * findAll('a') => [].slice.call(document.querySelectorAll('a')) + * findAll(nav, 'a') => [].slice.call(nav.querySelectorAll('a')) + */ +export function findAll(el, node) { + return [].slice.call( + node ? el.querySelectorAll(node) : $.querySelectorAll(el) + ) +} + +export function create(node, tpl) { + node = $.createElement(node) + if (tpl) { + node.innerHTML = tpl + } + return node +} + +export function appendTo(target, el) { + return target.appendChild(el) +} + +export function before(target, el) { + return target.insertBefore(el, target.children[0]) +} + +export function on(el, type, handler) { + isFn(type) ? + window.addEventListener(el, type) : + el.addEventListener(type, handler) +} + +export function off(el, type, handler) { + isFn(type) ? + window.removeEventListener(el, type) : + el.removeEventListener(type, handler) +} + +/** + * Toggle class + * + * @example + * toggleClass(el, 'active') => el.classList.toggle('active') + * toggleClass(el, 'add', 'active') => el.classList.add('active') + */ +export function toggleClass(el, type, val) { + el && el.classList[val ? type : 'toggle'](val || type) +} + +export function style(content) { + appendTo(head, create('style', content)) +} diff --git a/src/core/util/env.js b/src/core/util/env.js new file mode 100644 index 0000000..cd51635 --- /dev/null +++ b/src/core/util/env.js @@ -0,0 +1,21 @@ +export const inBrowser = !process.env.SSR + +export const isMobile = inBrowser && document.body.clientWidth <= 600 + +/** + * @see https://github.com/MoOx/pjax/blob/master/lib/is-supported.js + */ +export const supportsPushState = + inBrowser && + (function () { + // Borrowed wholesale from https://github.com/defunkt/jquery-pjax + return ( + window.history && + window.history.pushState && + window.history.replaceState && + // PushState isn’t reliable on iOS until 5. + !navigator.userAgent.match( + /((iPod|iPhone|iPad).+\bOS\s+[1-4]\D|WebApps\/.+CFNetwork)/ + ) + ) + })() diff --git a/src/core/util/index.js b/src/core/util/index.js new file mode 100644 index 0000000..eba6598 --- /dev/null +++ b/src/core/util/index.js @@ -0,0 +1,3 @@ +export * from './core' +export * from './env' +export * from '../router/util' diff --git a/src/core/util/polyfill/css-vars.js b/src/core/util/polyfill/css-vars.js new file mode 100644 index 0000000..fb3a80a --- /dev/null +++ b/src/core/util/polyfill/css-vars.js @@ -0,0 +1,36 @@ +import * as dom from '../dom' +import {get} from '../../fetch/ajax' + +function replaceVar(block, color) { + block.innerHTML = block.innerHTML.replace( + /var\(\s*--theme-color.*?\)/g, + color + ) +} + +export default function (color) { + // Variable support + if (window.CSS && window.CSS.supports && window.CSS.supports('(--v:red)')) { + return + } + + const styleBlocks = dom.findAll('style:not(.inserted),link'); + [].forEach.call(styleBlocks, block => { + if (block.nodeName === 'STYLE') { + replaceVar(block, color) + } else if (block.nodeName === 'LINK') { + const href = block.getAttribute('href') + + if (!/\.css$/.test(href)) { + return + } + + get(href).then(res => { + const style = dom.create('style', res) + + dom.head.appendChild(style) + replaceVar(style, color) + }) + } + }) +} diff --git a/src/event.js b/src/event.js deleted file mode 100644 index 45f558a..0000000 --- a/src/event.js +++ /dev/null @@ -1,123 +0,0 @@ -import { isMobile } from './util' - -/** - * Active sidebar when scroll - * @link https://buble.surge.sh/ - */ -export function scrollActiveSidebar () { - if (isMobile()) return - - const anchors = document.querySelectorAll('.anchor') - const nav = {} - const lis = document.querySelectorAll('.sidebar li') - let active = null - - for (let i = 0, len = lis.length; i < len; i += 1) { - const li = lis[i] - let href = li.querySelector('a').getAttribute('href') - - if (href !== '/') { - const match = href.match('#([^#]+)$') - if (match && match.length) href = match[0].slice(1) - } - - nav[decodeURIComponent(href)] = li - } - - function highlight () { - for (let i = 0, len = anchors.length; i < len; i += 1) { - const node = anchors[i] - const bcr = node.getBoundingClientRect() - - if (bcr.top < 10 && bcr.bottom > 10) { - const li = nav[node.getAttribute('data-id')] - - if (!li || li === active) return - if (active) active.setAttribute('class', '') - - li.setAttribute('class', 'active') - active = li - - return - } - } - } - - window.removeEventListener('scroll', highlight) - window.addEventListener('scroll', highlight) - highlight() -} - -export function scrollIntoView () { - const id = window.location.hash.match(/#[^#\/]+$/g) - if (!id || !id.length) return - const section = document.querySelector(decodeURIComponent(id[0])) - - if (section) section.scrollIntoView() -} - -/** - * Acitve link - */ -export function activeLink (dom, activeParent) { - const host = window.location.href - - dom = typeof dom === 'object' ? dom : document.querySelector(dom) - if (!dom) return - let target - - ;[].slice.call(dom.querySelectorAll('a')) - .sort((a, b) => b.href.length - a.href.length) - .forEach(node => { - if (host.indexOf(node.href) === 0 && !target) { - activeParent - ? node.parentNode.setAttribute('class', 'active') - : node.setAttribute('class', 'active') - target = node - } else { - activeParent - ? node.parentNode.removeAttribute('class') - : node.removeAttribute('class') - } - }) - - return target -} - -/** - * sidebar toggle - */ -export function bindToggle (dom) { - dom = typeof dom === 'object' ? dom : document.querySelector(dom) - if (!dom) return - const body = document.body - - dom.addEventListener('click', () => body.classList.toggle('close')) - - if (!/mobile/i.test(navigator.userAgent)) return - document.querySelector('aside').addEventListener('click', event => { - body.classList.toggle('close') - }) -} - -let cacheContentDOM -export function scroll2Top () { - if (!cacheContentDOM) { - const dom = isMobile() ? 'body' : 'section.content' - cacheContentDOM = document.querySelector(dom) - } - cacheContentDOM.scrollTop = 0 -} - -export function sticky () { - const dom = document.querySelector('section.cover') - const coverHeight = dom.getBoundingClientRect().height - - return (function () { - if (window.pageYOffset >= coverHeight || dom.classList.contains('hidden')) { - document.body.classList.add('sticky') - } else { - document.body.classList.remove('sticky') - } - })() -} diff --git a/src/index.js b/src/index.js deleted file mode 100644 index e61c644..0000000 --- a/src/index.js +++ /dev/null @@ -1,107 +0,0 @@ -import { load, camel2kebab, isNil, getRoute } from './util' -import { scrollIntoView } from './event' -import * as render from './render' - -const OPTIONS = { - el: '#app', - repo: '', - maxLevel: 6, - subMaxLevel: 0, - sidebar: '', - sidebarToggle: false, - loadSidebar: null, - loadNavbar: null, - router: false, - homepage: 'README.md', - coverpage: '', - basePath: '', - auto2top: false -} -const script = document.currentScript || [].slice.call(document.getElementsByTagName('script')).pop() - -// load configuration for script attribute -if (script) { - for (const prop in OPTIONS) { - const val = script.getAttribute('data-' + camel2kebab(prop)) - OPTIONS[prop] = isNil(val) ? OPTIONS[prop] : (val || true) - } - if (OPTIONS.loadSidebar === true) OPTIONS.loadSidebar = '_sidebar.md' - if (OPTIONS.loadNavbar === true) OPTIONS.loadNavbar = '_navbar.md' - if (OPTIONS.coverpage === true) OPTIONS.coverpage = '_coverpage.md' - if (OPTIONS.sidebar) OPTIONS.sidebar = window[OPTIONS.sidebar] -} - -// load options -render.config(OPTIONS) - -let cacheRoute = null -let cacheXhr = null - -const mainRender = function (cb) { - const route = OPTIONS.basePath + getRoute() - if (cacheRoute === route) return cb() - - let basePath = cacheRoute = route - - if (!/\//.test(basePath)) { - basePath = '' - } else if (basePath && !/\/$/.test(basePath)) { - basePath = basePath.match(/(\S*\/)[^\/]+$/)[1] - } - - let page - if (!route) { - page = OPTIONS.homepage || 'README.md' - } else if (/\/$/.test(route)) { - page = `${route}README.md` - } else { - page = `${route}.md` - } - - // Render Cover page - if (OPTIONS.coverpage && page === OPTIONS.homepage) { - load(OPTIONS.coverpage).then(render.renderCover) - } - - cacheXhr && cacheXhr.abort && cacheXhr.abort() - // Render markdown file - cacheXhr = load(page, 'GET', render.renderLoading) - cacheXhr.then(result => { - render.renderArticle(result) - // clear cover - if (OPTIONS.coverpage && page !== OPTIONS.homepage) render.renderCover() - // render sidebar - if (OPTIONS.loadSidebar) { - load(basePath + OPTIONS.loadSidebar) - .then(result => { - render.renderSidebar(result) - cb() - }) - } else { - cb() - } - }, _ => render.renderArticle(null)) - - // Render navbar - if (OPTIONS.loadNavbar) { - load(basePath + OPTIONS.loadNavbar).then(render.renderNavbar) - } -} - -const Docsify = function () { - const dom = document.querySelector(OPTIONS.el) || document.body - const replace = dom !== document.body - const main = function () { - mainRender(_ => scrollIntoView()) - } - - // Render app - render.renderApp(dom, replace) - main() - if (OPTIONS.router) { - if (!/^#\//.test(window.location.hash)) window.location.hash = '#/' - window.addEventListener('hashchange', main) - } -} - -export default Docsify() diff --git a/src/plugins/disqus.js b/src/plugins/disqus.js new file mode 100644 index 0000000..dba7aef --- /dev/null +++ b/src/plugins/disqus.js @@ -0,0 +1,51 @@ +const fixedPath = location.href.replace('/-/', '/#/') +if (fixedPath !== location.href) { + location.href = fixedPath +} + +function install(hook, vm) { + const dom = Docsify.dom + const disqus = vm.config.disqus + if (!disqus) { + throw Error('$docsify.disqus is required') + } + + hook.init(_ => { + const script = dom.create('script') + + script.async = true + script.src = `https://${disqus}.disqus.com/embed.js` + script.setAttribute('data-timestamp', Number(new Date())) + dom.appendTo(dom.body, script) + }) + + hook.mounted(_ => { + const div = dom.create('div') + div.id = 'disqus_thread' + const main = dom.getNode('#main') + div.style = `width: ${main.clientWidth}px; margin: 0 auto 20px;` + dom.appendTo(dom.find('.content'), div) + + // eslint-disable-next-line + window.disqus_config = function() { + this.page.url = location.origin + '/-' + vm.route.path + this.page.identifier = vm.route.path + this.page.title = document.title + } + }) + + hook.doneEach(_ => { + if (typeof window.DISQUS !== 'undefined') { + window.DISQUS.reset({ + reload: true, + config: function () { + this.page.url = location.origin + '/-' + vm.route.path + this.page.identifier = vm.route.path + this.page.title = document.title + } + }) + } + }) +} + +$docsify.plugins = [].concat(install, $docsify.plugins) diff --git a/src/plugins/emoji.js b/src/plugins/emoji.js new file mode 100644 index 0000000..31f1059 --- /dev/null +++ b/src/plugins/emoji.js @@ -0,0 +1,900 @@ +const AllGithubEmoji = [ + '+1', + '100', + '1234', + '8ball', + 'a', + 'ab', + 'abc', + 'abcd', + 'accept', + 'aerial_tramway', + 'airplane', + 'alarm_clock', + 'alien', + 'ambulance', + 'anchor', + 'angel', + 'anger', + 'angry', + 'anguished', + 'ant', + 'apple', + 'aquarius', + 'aries', + 'arrow_backward', + 'arrow_double_down', + 'arrow_double_up', + 'arrow_down', + 'arrow_down_small', + 'arrow_forward', + 'arrow_heading_down', + 'arrow_heading_up', + 'arrow_left', + 'arrow_lower_left', + 'arrow_lower_right', + 'arrow_right', + 'arrow_right_hook', + 'arrow_up', + 'arrow_up_down', + 'arrow_up_small', + 'arrow_upper_left', + 'arrow_upper_right', + 'arrows_clockwise', + 'arrows_counterclockwise', + 'art', + 'articulated_lorry', + 'astonished', + 'athletic_shoe', + 'atm', + 'b', + 'baby', + 'baby_bottle', + 'baby_chick', + 'baby_symbol', + 'back', + 'baggage_claim', + 'balloon', + 'ballot_box_with_check', + 'bamboo', + 'banana', + 'bangbang', + 'bank', + 'bar_chart', + 'barber', + 'baseball', + 'basketball', + 'bath', + 'bathtub', + 'battery', + 'bear', + 'bee', + 'beer', + 'beers', + 'beetle', + 'beginner', + 'bell', + 'bento', + 'bicyclist', + 'bike', + 'bikini', + 'bird', + 'birthday', + 'black_circle', + 'black_joker', + 'black_large_square', + 'black_medium_small_square', + 'black_medium_square', + 'black_nib', + 'black_small_square', + 'black_square_button', + 'blossom', + 'blowfish', + 'blue_book', + 'blue_car', + 'blue_heart', + 'blush', + 'boar', + 'boat', + 'bomb', + 'book', + 'bookmark', + 'bookmark_tabs', + 'books', + 'boom', + 'boot', + 'bouquet', + 'bow', + 'bowling', + 'bowtie', + 'boy', + 'bread', + 'bride_with_veil', + 'bridge_at_night', + 'briefcase', + 'broken_heart', + 'bug', + 'bulb', + 'bullettrain_front', + 'bullettrain_side', + 'bus', + 'busstop', + 'bust_in_silhouette', + 'busts_in_silhouette', + 'cactus', + 'cake', + 'calendar', + 'calling', + 'camel', + 'camera', + 'cancer', + 'candy', + 'capital_abcd', + 'capricorn', + 'car', + 'card_index', + 'carousel_horse', + 'cat', + 'cat2', + 'cd', + 'chart', + 'chart_with_downwards_trend', + 'chart_with_upwards_trend', + 'checkered_flag', + 'cherries', + 'cherry_blossom', + 'chestnut', + 'chicken', + 'children_crossing', + 'chocolate_bar', + 'christmas_tree', + 'church', + 'cinema', + 'circus_tent', + 'city_sunrise', + 'city_sunset', + 'cl', + 'clap', + 'clapper', + 'clipboard', + 'clock1', + 'clock10', + 'clock1030', + 'clock11', + 'clock1130', + 'clock12', + 'clock1230', + 'clock130', + 'clock2', + 'clock230', + 'clock3', + 'clock330', + 'clock4', + 'clock430', + 'clock5', + 'clock530', + 'clock6', + 'clock630', + 'clock7', + 'clock730', + 'clock8', + 'clock830', + 'clock9', + 'clock930', + 'closed_book', + 'closed_lock_with_key', + 'closed_umbrella', + 'cloud', + 'clubs', + 'cn', + 'cocktail', + 'coffee', + 'cold_sweat', + 'collision', + 'computer', + 'confetti_ball', + 'confounded', + 'confused', + 'congratulations', + 'construction', + 'construction_worker', + 'convenience_store', + 'cookie', + 'cool', + 'cop', + 'copyright', + 'corn', + 'couple', + 'couple_with_heart', + 'couplekiss', + 'cow', + 'cow2', + 'credit_card', + 'crescent_moon', + 'crocodile', + 'crossed_flags', + 'crown', + 'cry', + 'crying_cat_face', + 'crystal_ball', + 'cupid', + 'curly_loop', + 'currency_exchange', + 'curry', + 'custard', + 'customs', + 'cyclone', + 'dancer', + 'dancers', + 'dango', + 'dart', + 'dash', + 'date', + 'de', + 'deciduous_tree', + 'department_store', + 'diamond_shape_with_a_dot_inside', + 'diamonds', + 'disappointed', + 'disappointed_relieved', + 'dizzy', + 'dizzy_face', + 'do_not_litter', + 'dog', + 'dog2', + 'dollar', + 'dolls', + 'dolphin', + 'door', + 'doughnut', + 'dragon', + 'dragon_face', + 'dress', + 'dromedary_camel', + 'droplet', + 'dvd', + 'e-mail', + 'ear', + 'ear_of_rice', + 'earth_africa', + 'earth_americas', + 'earth_asia', + 'egg', + 'eggplant', + 'eight', + 'eight_pointed_black_star', + 'eight_spoked_asterisk', + 'electric_plug', + 'elephant', + 'email', + 'end', + 'envelope', + 'envelope_with_arrow', + 'es', + 'euro', + 'european_castle', + 'european_post_office', + 'evergreen_tree', + 'exclamation', + 'expressionless', + 'eyeglasses', + 'eyes', + 'facepunch', + 'factory', + 'fallen_leaf', + 'family', + 'fast_forward', + 'fax', + 'fearful', + 'feelsgood', + 'feet', + 'ferris_wheel', + 'file_folder', + 'finnadie', + 'fire', + 'fire_engine', + 'fireworks', + 'first_quarter_moon', + 'first_quarter_moon_with_face', + 'fish', + 'fish_cake', + 'fishing_pole_and_fish', + 'fist', + 'five', + 'flags', + 'flashlight', + 'flipper', + 'floppy_disk', + 'flower_playing_cards', + 'flushed', + 'foggy', + 'football', + 'footprints', + 'fork_and_knife', + 'fountain', + 'four', + 'four_leaf_clover', + 'fr', + 'free', + 'fried_shrimp', + 'fries', + 'frog', + 'frowning', + 'fu', + 'fuelpump', + 'full_moon', + 'full_moon_with_face', + 'game_die', + 'gb', + 'gem', + 'gemini', + 'ghost', + 'gift', + 'gift_heart', + 'girl', + 'globe_with_meridians', + 'goat', + 'goberserk', + 'godmode', + 'golf', + 'grapes', + 'green_apple', + 'green_book', + 'green_heart', + 'grey_exclamation', + 'grey_question', + 'grimacing', + 'grin', + 'grinning', + 'guardsman', + 'guitar', + 'gun', + 'haircut', + 'hamburger', + 'hammer', + 'hamster', + 'hand', + 'handbag', + 'hankey', + 'hash', + 'hatched_chick', + 'hatching_chick', + 'headphones', + 'hear_no_evil', + 'heart', + 'heart_decoration', + 'heart_eyes', + 'heart_eyes_cat', + 'heartbeat', + 'heartpulse', + 'hearts', + 'heavy_check_mark', + 'heavy_division_sign', + 'heavy_dollar_sign', + 'heavy_exclamation_mark', + 'heavy_minus_sign', + 'heavy_multiplication_x', + 'heavy_plus_sign', + 'helicopter', + 'herb', + 'hibiscus', + 'high_brightness', + 'high_heel', + 'hocho', + 'honey_pot', + 'honeybee', + 'horse', + 'horse_racing', + 'hospital', + 'hotel', + 'hotsprings', + 'hourglass', + 'hourglass_flowing_sand', + 'house', + 'house_with_garden', + 'hurtrealbad', + 'hushed', + 'ice_cream', + 'icecream', + 'id', + 'ideograph_advantage', + 'imp', + 'inbox_tray', + 'incoming_envelope', + 'information_desk_person', + 'information_source', + 'innocent', + 'interrobang', + 'iphone', + 'it', + 'izakaya_lantern', + 'jack_o_lantern', + 'japan', + 'japanese_castle', + 'japanese_goblin', + 'japanese_ogre', + 'jeans', + 'joy', + 'joy_cat', + 'jp', + 'key', + 'keycap_ten', + 'kimono', + 'kiss', + 'kissing', + 'kissing_cat', + 'kissing_closed_eyes', + 'kissing_heart', + 'kissing_smiling_eyes', + 'koala', + 'koko', + 'kr', + 'lantern', + 'large_blue_circle', + 'large_blue_diamond', + 'large_orange_diamond', + 'last_quarter_moon', + 'last_quarter_moon_with_face', + 'laughing', + 'leaves', + 'ledger', + 'left_luggage', + 'left_right_arrow', + 'leftwards_arrow_with_hook', + 'lemon', + 'leo', + 'leopard', + 'libra', + 'light_rail', + 'link', + 'lips', + 'lipstick', + 'lock', + 'lock_with_ink_pen', + 'lollipop', + 'loop', + 'loud_sound', + 'loudspeaker', + 'love_hotel', + 'love_letter', + 'low_brightness', + 'm', + 'mag', + 'mag_right', + 'mahjong', + 'mailbox', + 'mailbox_closed', + 'mailbox_with_mail', + 'mailbox_with_no_mail', + 'man', + 'man_with_gua_pi_mao', + 'man_with_turban', + 'mans_shoe', + 'maple_leaf', + 'mask', + 'massage', + 'meat_on_bone', + 'mega', + 'melon', + 'memo', + 'mens', + 'metal', + 'metro', + 'microphone', + 'microscope', + 'milky_way', + 'minibus', + 'minidisc', + 'mobile_phone_off', + 'money_with_wings', + 'moneybag', + 'monkey', + 'monkey_face', + 'monorail', + 'moon', + 'mortar_board', + 'mount_fuji', + 'mountain_bicyclist', + 'mountain_cableway', + 'mountain_railway', + 'mouse', + 'mouse2', + 'movie_camera', + 'moyai', + 'muscle', + 'mushroom', + 'musical_keyboard', + 'musical_note', + 'musical_score', + 'mute', + 'nail_care', + 'name_badge', + 'neckbeard', + 'necktie', + 'negative_squared_cross_mark', + 'neutral_face', + 'new', + 'new_moon', + 'new_moon_with_face', + 'newspaper', + 'ng', + 'night_with_stars', + 'nine', + 'no_bell', + 'no_bicycles', + 'no_entry', + 'no_entry_sign', + 'no_good', + 'no_mobile_phones', + 'no_mouth', + 'no_pedestrians', + 'no_smoking', + 'non-potable_water', + 'nose', + 'notebook', + 'notebook_with_decorative_cover', + 'notes', + 'nut_and_bolt', + 'o', + 'o2', + 'ocean', + 'octocat', + 'octopus', + 'oden', + 'office', + 'ok', + 'ok_hand', + 'ok_woman', + 'older_man', + 'older_woman', + 'on', + 'oncoming_automobile', + 'oncoming_bus', + 'oncoming_police_car', + 'oncoming_taxi', + 'one', + 'open_book', + 'open_file_folder', + 'open_hands', + 'open_mouth', + 'ophiuchus', + 'orange_book', + 'outbox_tray', + 'ox', + 'package', + 'page_facing_up', + 'page_with_curl', + 'pager', + 'palm_tree', + 'panda_face', + 'paperclip', + 'parking', + 'part_alternation_mark', + 'partly_sunny', + 'passport_control', + 'paw_prints', + 'peach', + 'pear', + 'pencil', + 'pencil2', + 'penguin', + 'pensive', + 'performing_arts', + 'persevere', + 'person_frowning', + 'person_with_blond_hair', + 'person_with_pouting_face', + 'phone', + 'pig', + 'pig2', + 'pig_nose', + 'pill', + 'pineapple', + 'pisces', + 'pizza', + 'point_down', + 'point_left', + 'point_right', + 'point_up', + 'point_up_2', + 'police_car', + 'poodle', + 'poop', + 'post_office', + 'postal_horn', + 'postbox', + 'potable_water', + 'pouch', + 'poultry_leg', + 'pound', + 'pouting_cat', + 'pray', + 'princess', + 'punch', + 'purple_heart', + 'purse', + 'pushpin', + 'put_litter_in_its_place', + 'question', + 'rabbit', + 'rabbit2', + 'racehorse', + 'radio', + 'radio_button', + 'rage', + 'rage1', + 'rage2', + 'rage3', + 'rage4', + 'railway_car', + 'rainbow', + 'raised_hand', + 'raised_hands', + 'raising_hand', + 'ram', + 'ramen', + 'rat', + 'recycle', + 'red_car', + 'red_circle', + 'registered', + 'relaxed', + 'relieved', + 'repeat', + 'repeat_one', + 'restroom', + 'revolving_hearts', + 'rewind', + 'ribbon', + 'rice', + 'rice_ball', + 'rice_cracker', + 'rice_scene', + 'ring', + 'rocket', + 'roller_coaster', + 'rooster', + 'rose', + 'rotating_light', + 'round_pushpin', + 'rowboat', + 'ru', + 'rugby_football', + 'runner', + 'running', + 'running_shirt_with_sash', + 'sa', + 'sagittarius', + 'sailboat', + 'sake', + 'sandal', + 'santa', + 'satellite', + 'satisfied', + 'saxophone', + 'school', + 'school_satchel', + 'scissors', + 'scorpius', + 'scream', + 'scream_cat', + 'scroll', + 'seat', + 'secret', + 'see_no_evil', + 'seedling', + 'seven', + 'shaved_ice', + 'sheep', + 'shell', + 'ship', + 'shipit', + 'shirt', + 'shit', + 'shoe', + 'shower', + 'signal_strength', + 'six', + 'six_pointed_star', + 'ski', + 'skull', + 'sleeping', + 'sleepy', + 'slot_machine', + 'small_blue_diamond', + 'small_orange_diamond', + 'small_red_triangle', + 'small_red_triangle_down', + 'smile', + 'smile_cat', + 'smiley', + 'smiley_cat', + 'smiling_imp', + 'smirk', + 'smirk_cat', + 'smoking', + 'snail', + 'snake', + 'snowboarder', + 'snowflake', + 'snowman', + 'sob', + 'soccer', + 'soon', + 'sos', + 'sound', + 'space_invader', + 'spades', + 'spaghetti', + 'sparkle', + 'sparkler', + 'sparkles', + 'sparkling_heart', + 'speak_no_evil', + 'speaker', + 'speech_balloon', + 'speedboat', + 'squirrel', + 'star', + 'star2', + 'stars', + 'station', + 'statue_of_liberty', + 'steam_locomotive', + 'stew', + 'straight_ruler', + 'strawberry', + 'stuck_out_tongue', + 'stuck_out_tongue_closed_eyes', + 'stuck_out_tongue_winking_eye', + 'sun_with_face', + 'sunflower', + 'sunglasses', + 'sunny', + 'sunrise', + 'sunrise_over_mountains', + 'surfer', + 'sushi', + 'suspect', + 'suspension_railway', + 'sweat', + 'sweat_drops', + 'sweat_smile', + 'sweet_potato', + 'swimmer', + 'symbols', + 'syringe', + 'tada', + 'tanabata_tree', + 'tangerine', + 'taurus', + 'taxi', + 'tea', + 'telephone', + 'telephone_receiver', + 'telescope', + 'tennis', + 'tent', + 'thought_balloon', + 'three', + 'thumbsdown', + 'thumbsup', + 'ticket', + 'tiger', + 'tiger2', + 'tired_face', + 'tm', + 'toilet', + 'tokyo_tower', + 'tomato', + 'tongue', + 'top', + 'tophat', + 'tractor', + 'traffic_light', + 'train', + 'train2', + 'tram', + 'triangular_flag_on_post', + 'triangular_ruler', + 'trident', + 'triumph', + 'trolleybus', + 'trollface', + 'trophy', + 'tropical_drink', + 'tropical_fish', + 'truck', + 'trumpet', + 'tshirt', + 'tulip', + 'turtle', + 'tv', + 'twisted_rightwards_arrows', + 'two', + 'two_hearts', + 'two_men_holding_hands', + 'two_women_holding_hands', + 'u5272', + 'u5408', + 'u55b6', + 'u6307', + 'u6708', + 'u6709', + 'u6e80', + 'u7121', + 'u7533', + 'u7981', + 'u7a7a', + 'uk', + 'umbrella', + 'unamused', + 'underage', + 'unlock', + 'up', + 'us', + 'v', + 'vertical_traffic_light', + 'vhs', + 'vibration_mode', + 'video_camera', + 'video_game', + 'violin', + 'virgo', + 'volcano', + 'vs', + 'walking', + 'waning_crescent_moon', + 'waning_gibbous_moon', + 'warning', + 'watch', + 'water_buffalo', + 'watermelon', + 'wave', + 'wavy_dash', + 'waxing_crescent_moon', + 'waxing_gibbous_moon', + 'wc', + 'weary', + 'wedding', + 'whale', + 'whale2', + 'wheelchair', + 'white_check_mark', + 'white_circle', + 'white_flower', + 'white_large_square', + 'white_medium_small_square', + 'white_medium_square', + 'white_small_square', + 'white_square_button', + 'wind_chime', + 'wine_glass', + 'wink', + 'wolf', + 'woman', + 'womans_clothes', + 'womans_hat', + 'womens', + 'worried', + 'wrench', + 'x', + 'yellow_heart', + 'yen', + 'yum', + 'zap', + 'zero', + 'zzz' +] + +// Emoji from All-Github-Emoji-Icons +// https://github.com/scotch-io/All-Github-Emoji-Icons +window.emojify = function (match, $1) { + return AllGithubEmoji.indexOf($1) === -1 ? + match : + '
'
+}
diff --git a/src/plugins/external-script.js b/src/plugins/external-script.js
new file mode 100644
index 0000000..2954030
--- /dev/null
+++ b/src/plugins/external-script.js
@@ -0,0 +1,25 @@
+function handleExternalScript() {
+ const container = Docsify.dom.getNode('#main')
+ const scripts = Docsify.dom.findAll(container, 'script')
+
+ for (let i = scripts.length; i--;) {
+ const script = scripts[i]
+
+ if (script && script.src) {
+ const newScript = document.createElement('script')
+
+ Array.prototype.slice.call(script.attributes).forEach(attribute => {
+ newScript[attribute.name] = attribute.value
+ })
+
+ script.parentNode.insertBefore(newScript, script)
+ script.parentNode.removeChild(script)
+ }
+ }
+}
+
+const install = function (hook) {
+ hook.doneEach(handleExternalScript)
+}
+
+window.$docsify.plugins = [].concat(install, window.$docsify.plugins)
diff --git a/src/plugins/front-matter/index.js b/src/plugins/front-matter/index.js
new file mode 100644
index 0000000..cb90ed9
--- /dev/null
+++ b/src/plugins/front-matter/index.js
@@ -0,0 +1,13 @@
+import parser from './parser'
+
+const install = function (hook, vm) {
+ hook.beforeEach(content => {
+ const {attributes, body} = parser(content)
+
+ vm.frontmatter = attributes
+
+ return body
+ })
+}
+
+$docsify.plugins = [].concat(install, $docsify.plugins)
diff --git a/src/plugins/front-matter/parser.js b/src/plugins/front-matter/parser.js
new file mode 100644
index 0000000..f0ae377
--- /dev/null
+++ b/src/plugins/front-matter/parser.js
@@ -0,0 +1,55 @@
+/**
+ * Fork https://github.com/egoist/docute/blob/master/src/utils/front-matter.js
+ */
+/* eslint-disable */
+import parser from './yaml'
+
+var optionalByteOrderMark = '\\ufeff?'
+var pattern =
+ '^(' +
+ optionalByteOrderMark +
+ '(= yaml =|---)' +
+ '$([\\s\\S]*?)' +
+ '(?:\\2|\\.\\.\\.)' +
+ '$' +
+ '' +
+ '(?:\\n)?)'
+// NOTE: If this pattern uses the 'g' flag the `regex` variable definition will
+// need to be moved down into the functions that use it.
+var regex = new RegExp(pattern, 'm')
+
+function extractor(string) {
+ string = string || ''
+
+ var lines = string.split(/(\r?\n)/)
+ if (lines[0] && /= yaml =|---/.test(lines[0])) {
+ return parse(string)
+ } else {
+ return { attributes: {}, body: string }
+ }
+}
+
+function parse(string) {
+ var match = regex.exec(string)
+
+ if (!match) {
+ return {
+ attributes: {},
+ body: string
+ }
+ }
+
+ var yaml = match[match.length - 1].replace(/^\s+|\s+$/g, '')
+ var attributes = parser(yaml) || {}
+ var body = string.replace(match[0], '')
+
+ return { attributes: attributes, body: body, frontmatter: yaml }
+}
+
+function test(string) {
+ string = string || ''
+
+ return regex.test(string)
+}
+
+export default extractor
diff --git a/src/plugins/front-matter/yaml.js b/src/plugins/front-matter/yaml.js
new file mode 100644
index 0000000..b947463
--- /dev/null
+++ b/src/plugins/front-matter/yaml.js
@@ -0,0 +1,466 @@
+/**
+ * Fork https://github.com/egoist/docute/blob/master/src/utils/yaml.js
+ */
+/* eslint-disable */
+/*
+YAML parser for Javascript
+Author: Diogo Costa
+This program is released under the MIT License as follows:
+Copyright (c) 2011 Diogo Costa (costa.h4evr@gmail.com)
+Permission is hereby granted, free of charge, to any person obtaining a copy
+ of this software and associated documentation files (the "Software"), to deal
+ in the Software without restriction, including without limitation the rights
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ copies of the Software, and to permit persons to whom the Software is
+ furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in
+ all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ THE SOFTWARE.
+*/
+
+/**
+ * @name YAML
+ * @namespace
+*/
+
+var errors = [],
+ reference_blocks = [],
+ processing_time = 0,
+ regex = {
+ regLevel: new RegExp('^([\\s\\-]+)'),
+ invalidLine: new RegExp('^\\-\\-\\-|^\\.\\.\\.|^\\s*#.*|^\\s*$'),
+ dashesString: new RegExp('^\\s*\\"([^\\"]*)\\"\\s*$'),
+ quotesString: new RegExp("^\\s*\\'([^\\']*)\\'\\s*$"),
+ float: new RegExp('^[+-]?[0-9]+\\.[0-9]+(e[+-]?[0-9]+(\\.[0-9]+)?)?$'),
+ integer: new RegExp('^[+-]?[0-9]+$'),
+ array: new RegExp('\\[\\s*(.*)\\s*\\]'),
+ map: new RegExp('\\{\\s*(.*)\\s*\\}'),
+ key_value: new RegExp('([a-z0-9_-][ a-z0-9_-]*):( .+)', 'i'),
+ single_key_value: new RegExp('^([a-z0-9_-][ a-z0-9_-]*):( .+?)$', 'i'),
+ key: new RegExp('([a-z0-9_-][ a-z0-9_-]+):( .+)?', 'i'),
+ item: new RegExp('^-\\s+'),
+ trim: new RegExp('^\\s+|\\s+$'),
+ comment: new RegExp('([^\\\'\\"#]+([\\\'\\"][^\\\'\\"]*[\\\'\\"])*)*(#.*)?')
+ }
+
+/**
+ * @class A block of lines of a given level.
+ * @param {int} lvl The block's level.
+ * @private
+ */
+function Block(lvl) {
+ return {
+ /* The block's parent */
+ parent: null,
+ /* Number of children */
+ length: 0,
+ /* Block's level */
+ level: lvl,
+ /* Lines of code to process */
+ lines: [],
+ /* Blocks with greater level */
+ children: [],
+ /* Add a block to the children collection */
+ addChild: function(obj) {
+ this.children.push(obj)
+ obj.parent = this
+ ++this.length
+ }
+ }
+}
+
+// function to create an XMLHttpClient in a cross-browser manner
+function createXMLHTTPRequest() {
+ var xmlhttp
+
+ try {
+ // Mozilla / Safari / IE7
+ xmlhttp = new XMLHttpRequest()
+ } catch (e) {
+ // IE
+ var XMLHTTP_IDS = new Array(
+ 'MSXML2.XMLHTTP.5.0',
+ 'MSXML2.XMLHTTP.4.0',
+ 'MSXML2.XMLHTTP.3.0',
+ 'MSXML2.XMLHTTP',
+ 'Microsoft.XMLHTTP'
+ )
+ var success = false
+ for (var i = 0; i < XMLHTTP_IDS.length && !success; i++) {
+ try {
+ xmlhttp = new ActiveXObject(XMLHTTP_IDS[i])
+ success = true
+ } catch (e) {}
+ }
+ if (!success) {
+ throw new Error('Unable to create XMLHttpRequest.')
+ }
+ }
+
+ return xmlhttp
+}
+
+function parser(str) {
+ var regLevel = regex['regLevel']
+ var invalidLine = regex['invalidLine']
+ var lines = str.split('\n')
+ var m
+ var level = 0,
+ curLevel = 0
+
+ var blocks = []
+
+ var result = new Block(-1)
+ var currentBlock = new Block(0)
+ result.addChild(currentBlock)
+ var levels = []
+ var line = ''
+
+ blocks.push(currentBlock)
+ levels.push(level)
+
+ for (var i = 0, len = lines.length; i < len; ++i) {
+ line = lines[i]
+
+ if (line.match(invalidLine)) {
+ continue
+ }
+
+ if ((m = regLevel.exec(line))) {
+ level = m[1].length
+ } else level = 0
+
+ if (level > curLevel) {
+ var oldBlock = currentBlock
+ currentBlock = new Block(level)
+ oldBlock.addChild(currentBlock)
+ blocks.push(currentBlock)
+ levels.push(level)
+ } else if (level < curLevel) {
+ var added = false
+
+ var k = levels.length - 1
+ for (; k >= 0; --k) {
+ if (levels[k] == level) {
+ currentBlock = new Block(level)
+ blocks.push(currentBlock)
+ levels.push(level)
+ if (blocks[k].parent != null) blocks[k].parent.addChild(currentBlock)
+ added = true
+ break
+ }
+ }
+
+ if (!added) {
+ errors.push('Error: Invalid indentation at line ' + i + ': ' + line)
+ return
+ }
+ }
+
+ currentBlock.lines.push(line.replace(regex['trim'], ''))
+ curLevel = level
+ }
+
+ return result
+}
+
+function processValue(val) {
+ val = val.replace(regex['trim'], '')
+ var m = null
+
+ if (val == 'true') {
+ return true
+ } else if (val == 'false') {
+ return false
+ } else if (val == '.NaN') {
+ return Number.NaN
+ } else if (val == 'null') {
+ return null
+ } else if (val == '.inf') {
+ return Number.POSITIVE_INFINITY
+ } else if (val == '-.inf') {
+ return Number.NEGATIVE_INFINITY
+ } else if ((m = val.match(regex['dashesString']))) {
+ return m[1]
+ } else if ((m = val.match(regex['quotesString']))) {
+ return m[1]
+ } else if ((m = val.match(regex['float']))) {
+ return parseFloat(m[0])
+ } else if ((m = val.match(regex['integer']))) {
+ return parseInt(m[0])
+ } else if (!isNaN((m = Date.parse(val)))) {
+ return new Date(m)
+ } else if ((m = val.match(regex['single_key_value']))) {
+ var res = {}
+ res[m[1]] = processValue(m[2])
+ return res
+ } else if ((m = val.match(regex['array']))) {
+ var count = 0,
+ c = ' '
+ var res = []
+ var content = ''
+ var str = false
+ for (var j = 0, lenJ = m[1].length; j < lenJ; ++j) {
+ c = m[1][j]
+ if (c == "'" || c == '"') {
+ if (str === false) {
+ str = c
+ content += c
+ continue
+ } else if ((c == "'" && str == "'") || (c == '"' && str == '"')) {
+ str = false
+ content += c
+ continue
+ }
+ } else if (str === false && (c == '[' || c == '{')) {
+ ++count
+ } else if (str === false && (c == ']' || c == '}')) {
+ --count
+ } else if (str === false && count == 0 && c == ',') {
+ res.push(processValue(content))
+ content = ''
+ continue
+ }
+
+ content += c
+ }
+
+ if (content.length > 0) res.push(processValue(content))
+ return res
+ } else if ((m = val.match(regex['map']))) {
+ var count = 0,
+ c = ' '
+ var res = []
+ var content = ''
+ var str = false
+ for (var j = 0, lenJ = m[1].length; j < lenJ; ++j) {
+ c = m[1][j]
+ if (c == "'" || c == '"') {
+ if (str === false) {
+ str = c
+ content += c
+ continue
+ } else if ((c == "'" && str == "'") || (c == '"' && str == '"')) {
+ str = false
+ content += c
+ continue
+ }
+ } else if (str === false && (c == '[' || c == '{')) {
+ ++count
+ } else if (str === false && (c == ']' || c == '}')) {
+ --count
+ } else if (str === false && count == 0 && c == ',') {
+ res.push(content)
+ content = ''
+ continue
+ }
+
+ content += c
+ }
+
+ if (content.length > 0) res.push(content)
+
+ var newRes = {}
+ for (var j = 0, lenJ = res.length; j < lenJ; ++j) {
+ if ((m = res[j].match(regex['key_value']))) {
+ newRes[m[1]] = processValue(m[2])
+ }
+ }
+
+ return newRes
+ } else return val
+}
+
+function processFoldedBlock(block) {
+ var lines = block.lines
+ var children = block.children
+ var str = lines.join(' ')
+ var chunks = [str]
+ for (var i = 0, len = children.length; i < len; ++i) {
+ chunks.push(processFoldedBlock(children[i]))
+ }
+ return chunks.join('\n')
+}
+
+function processLiteralBlock(block) {
+ var lines = block.lines
+ var children = block.children
+ var str = lines.join('\n')
+ for (var i = 0, len = children.length; i < len; ++i) {
+ str += processLiteralBlock(children[i])
+ }
+ return str
+}
+
+function processBlock(blocks) {
+ var m = null
+ var res = {}
+ var lines = null
+ var children = null
+ var currentObj = null
+
+ var level = -1
+
+ var processedBlocks = []
+
+ var isMap = true
+
+ for (var j = 0, lenJ = blocks.length; j < lenJ; ++j) {
+ if (level != -1 && level != blocks[j].level) continue
+
+ processedBlocks.push(j)
+
+ level = blocks[j].level
+ lines = blocks[j].lines
+ children = blocks[j].children
+ currentObj = null
+
+ for (var i = 0, len = lines.length; i < len; ++i) {
+ var line = lines[i]
+
+ if ((m = line.match(regex['key']))) {
+ var key = m[1]
+
+ if (key[0] == '-') {
+ key = key.replace(regex['item'], '')
+ if (isMap) {
+ isMap = false
+ if (typeof res.length === 'undefined') {
+ res = []
+ }
+ }
+ if (currentObj != null) res.push(currentObj)
+ currentObj = {}
+ isMap = true
+ }
+
+ if (typeof m[2] != 'undefined') {
+ var value = m[2].replace(regex['trim'], '')
+ if (value[0] == '&') {
+ var nb = processBlock(children)
+ if (currentObj != null) currentObj[key] = nb
+ else res[key] = nb
+ reference_blocks[value.substr(1)] = nb
+ } else if (value[0] == '|') {
+ if (currentObj != null)
+ currentObj[key] = processLiteralBlock(children.shift())
+ else res[key] = processLiteralBlock(children.shift())
+ } else if (value[0] == '*') {
+ var v = value.substr(1)
+ var no = {}
+
+ if (typeof reference_blocks[v] == 'undefined') {
+ errors.push("Reference '" + v + "' not found!")
+ } else {
+ for (var k in reference_blocks[v]) {
+ no[k] = reference_blocks[v][k]
+ }
+
+ if (currentObj != null) currentObj[key] = no
+ else res[key] = no
+ }
+ } else if (value[0] == '>') {
+ if (currentObj != null)
+ currentObj[key] = processFoldedBlock(children.shift())
+ else res[key] = processFoldedBlock(children.shift())
+ } else {
+ if (currentObj != null) currentObj[key] = processValue(value)
+ else res[key] = processValue(value)
+ }
+ } else {
+ if (currentObj != null) currentObj[key] = processBlock(children)
+ else res[key] = processBlock(children)
+ }
+ } else if (line.match(/^-\s*$/)) {
+ if (isMap) {
+ isMap = false
+ if (typeof res.length === 'undefined') {
+ res = []
+ }
+ }
+ if (currentObj != null) res.push(currentObj)
+ currentObj = {}
+ isMap = true
+ continue
+ } else if ((m = line.match(/^-\s*(.*)/))) {
+ if (currentObj != null) currentObj.push(processValue(m[1]))
+ else {
+ if (isMap) {
+ isMap = false
+ if (typeof res.length === 'undefined') {
+ res = []
+ }
+ }
+ res.push(processValue(m[1]))
+ }
+ continue
+ }
+ }
+
+ if (currentObj != null) {
+ if (isMap) {
+ isMap = false
+ if (typeof res.length === 'undefined') {
+ res = []
+ }
+ }
+ res.push(currentObj)
+ }
+ }
+
+ for (var j = processedBlocks.length - 1; j >= 0; --j) {
+ blocks.splice.call(blocks, processedBlocks[j], 1)
+ }
+
+ return res
+}
+
+function semanticAnalysis(blocks) {
+ var res = processBlock(blocks.children)
+ return res
+}
+
+function preProcess(src) {
+ var m
+ var lines = src.split('\n')
+
+ var r = regex['comment']
+
+ for (var i in lines) {
+ if ((m = lines[i].match(r))) {
+ /* var cmt = "";
+ if(typeof m[3] != "undefined")
+ lines[i] = m[1];
+ else if(typeof m[3] != "undefined")
+ lines[i] = m[3];
+ else
+ lines[i] = "";
+ */
+ if (typeof m[3] !== 'undefined') {
+ lines[i] = m[0].substr(0, m[0].length - m[3].length)
+ }
+ }
+ }
+
+ return lines.join('\n')
+}
+
+function load(str) {
+ errors = []
+ reference_blocks = []
+ processing_time = new Date().getTime()
+ var pre = preProcess(str)
+ var doc = parser(pre)
+ var res = semanticAnalysis(doc)
+ processing_time = new Date().getTime() - processing_time
+
+ return res
+}
+
+export default load
diff --git a/src/plugins/ga.js b/src/plugins/ga.js
new file mode 100644
index 0000000..2d6419b
--- /dev/null
+++ b/src/plugins/ga.js
@@ -0,0 +1,38 @@
+// From https://github.com/egoist/vue-ga/blob/master/src/index.js
+function appendScript() {
+ const script = document.createElement('script')
+ script.async = true
+ script.src = 'https://www.google-analytics.com/analytics.js'
+ document.body.appendChild(script)
+}
+
+function init(id) {
+ appendScript()
+ window.ga =
+ window.ga ||
+ function () {
+ (window.ga.q = window.ga.q || []).push(arguments)
+ }
+ window.ga.l = Number(new Date())
+ window.ga('create', id, 'auto')
+}
+
+function collect() {
+ if (!window.ga) {
+ init($docsify.ga)
+ }
+
+ window.ga('set', 'page', location.hash)
+ window.ga('send', 'pageview')
+}
+
+const install = function (hook) {
+ if (!$docsify.ga) {
+ console.error('[Docsify] ga is required.')
+ return
+ }
+
+ hook.beforeEach(collect)
+}
+
+$docsify.plugins = [].concat(install, $docsify.plugins)
diff --git a/src/plugins/gitalk.js b/src/plugins/gitalk.js
new file mode 100644
index 0000000..8ba9ace
--- /dev/null
+++ b/src/plugins/gitalk.js
@@ -0,0 +1,23 @@
+function install(hook) {
+ const dom = Docsify.dom
+
+ hook.mounted(_ => {
+ const div = dom.create('div')
+ div.id = 'gitalk-container'
+ const main = dom.getNode('#main')
+ div.style = `width: ${main.clientWidth}px; margin: 0 auto 20px;`
+ dom.appendTo(dom.find('.content'), div)
+ })
+
+ hook.doneEach(_ => {
+ const el = document.getElementById('gitalk-container')
+ while (el.hasChildNodes()) {
+ el.removeChild(el.firstChild)
+ }
+
+ // eslint-disable-next-line
+ gitalk.render('gitalk-container')
+ })
+}
+
+$docsify.plugins = [].concat(install, $docsify.plugins)
diff --git a/src/plugins/matomo.js b/src/plugins/matomo.js
new file mode 100644
index 0000000..7b61cba
--- /dev/null
+++ b/src/plugins/matomo.js
@@ -0,0 +1,37 @@
+function appendScript(options) {
+ const script = document.createElement('script')
+ script.async = true
+ script.src = options.host + '/matomo.js'
+ document.body.appendChild(script)
+}
+
+function init(options) {
+ window._paq = window._paq || []
+ window._paq.push(['trackPageView'])
+ window._paq.push(['enableLinkTracking'])
+ setTimeout(function() {
+ appendScript(options)
+ window._paq.push(['setTrackerUrl', options.host + '/matomo.php'])
+ window._paq.push(['setSiteId', options.id + ''])
+ }, 0)
+}
+
+function collect() {
+ if (!window._paq) {
+ init($docsify.matomo)
+ }
+ window._paq.push(['setCustomUrl', window.location.hash.substr(1)])
+ window._paq.push(['setDocumentTitle', document.title])
+ window._paq.push(['trackPageView'])
+}
+
+const install = function (hook) {
+ if (!$docsify.matomo) {
+ console.error('[Docsify] matomo is required.')
+ return
+ }
+
+ hook.beforeEach(collect)
+}
+
+$docsify.plugins = [].concat(install, $docsify.plugins)
diff --git a/src/plugins/search/component.js b/src/plugins/search/component.js
new file mode 100644
index 0000000..42b0d19
--- /dev/null
+++ b/src/plugins/search/component.js
@@ -0,0 +1,225 @@
+import {search} from './search'
+
+let NO_DATA_TEXT = ''
+let options
+
+function style() {
+ const code = `
+.sidebar {
+ padding-top: 0;
+}
+
+.search {
+ margin-bottom: 20px;
+ padding: 6px;
+ border-bottom: 1px solid #eee;
+}
+
+.search .input-wrap {
+ display: flex;
+ align-items: center;
+}
+
+.search .results-panel {
+ display: none;
+}
+
+.search .results-panel.show {
+ display: block;
+}
+
+.search input {
+ outline: none;
+ border: none;
+ width: 100%;
+ padding: 0 7px;
+ line-height: 36px;
+ font-size: 14px;
+}
+
+.search input::-webkit-search-decoration,
+.search input::-webkit-search-cancel-button,
+.search input {
+ -webkit-appearance: none;
+ -moz-appearance: none;
+ appearance: none;
+}
+.search .clear-button {
+ width: 36px;
+ text-align: right;
+ display: none;
+}
+
+.search .clear-button.show {
+ display: block;
+}
+
+.search .clear-button svg {
+ transform: scale(.5);
+}
+
+.search h2 {
+ font-size: 17px;
+ margin: 10px 0;
+}
+
+.search a {
+ text-decoration: none;
+ color: inherit;
+}
+
+.search .matching-post {
+ border-bottom: 1px solid #eee;
+}
+
+.search .matching-post:last-child {
+ border-bottom: 0;
+}
+
+.search p {
+ font-size: 14px;
+ overflow: hidden;
+ text-overflow: ellipsis;
+ display: -webkit-box;
+ -webkit-line-clamp: 2;
+ -webkit-box-orient: vertical;
+}
+
+.search p.empty {
+ text-align: center;
+}
+
+.app-name.hide, .sidebar-nav.hide {
+ display: none;
+}`
+
+ Docsify.dom.style(code)
+}
+
+function tpl(defaultValue = '') {
+ const html =
+ `${NO_DATA_TEXT}
` + if (options.hideOtherSidebarContent) { + $sidebarNav.classList.add('hide') + $appName.classList.add('hide') + } +} + +function bindEvents() { + const $search = Docsify.dom.find('div.search') + const $input = Docsify.dom.find($search, 'input') + const $inputWrap = Docsify.dom.find($search, '.input-wrap') + + let timeId + // Prevent to Fold sidebar + Docsify.dom.on( + $search, + 'click', + e => e.target.tagName !== 'A' && e.stopPropagation() + ) + Docsify.dom.on($input, 'input', e => { + clearTimeout(timeId) + timeId = setTimeout(_ => doSearch(e.target.value.trim()), 100) + }) + Docsify.dom.on($inputWrap, 'click', e => { + // Click input outside + if (e.target.tagName !== 'INPUT') { + $input.value = '' + doSearch() + } + }) +} + +function updatePlaceholder(text, path) { + const $input = Docsify.dom.getNode('.search input[type="search"]') + + if (!$input) { + return + } + if (typeof text === 'string') { + $input.placeholder = text + } else { + const match = Object.keys(text).filter(key => path.indexOf(key) > -1)[0] + $input.placeholder = text[match] + } +} + +function updateNoData(text, path) { + if (typeof text === 'string') { + NO_DATA_TEXT = text + } else { + const match = Object.keys(text).filter(key => path.indexOf(key) > -1)[0] + NO_DATA_TEXT = text[match] + } +} + +function updateOptions(opts) { + options = opts +} + +export function init(opts, vm) { + const keywords = vm.router.parse().query.s + + updateOptions(opts) + style() + tpl(keywords) + bindEvents() + keywords && setTimeout(_ => doSearch(keywords), 500) +} + +export function update(opts, vm) { + updateOptions(opts) + updatePlaceholder(opts.placeholder, vm.route.path) + updateNoData(opts.noData, vm.route.path) +} diff --git a/src/plugins/search/index.js b/src/plugins/search/index.js new file mode 100644 index 0000000..bbd3af6 --- /dev/null +++ b/src/plugins/search/index.js @@ -0,0 +1,42 @@ +import {init as initComponet, update as updateComponent} from './component' +import {init as initSearch} from './search' + +const CONFIG = { + placeholder: 'Type to search', + noData: 'No Results!', + paths: 'auto', + depth: 2, + maxAge: 86400000, // 1 day + hideOtherSidebarContent: false, + namespace: undefined +} + +const install = function (hook, vm) { + const {util} = Docsify + const opts = vm.config.search || CONFIG + + if (Array.isArray(opts)) { + CONFIG.paths = opts + } else if (typeof opts === 'object') { + CONFIG.paths = Array.isArray(opts.paths) ? opts.paths : 'auto' + CONFIG.maxAge = util.isPrimitive(opts.maxAge) ? opts.maxAge : CONFIG.maxAge + CONFIG.placeholder = opts.placeholder || CONFIG.placeholder + CONFIG.noData = opts.noData || CONFIG.noData + CONFIG.depth = opts.depth || CONFIG.depth + CONFIG.hideOtherSidebarContent = opts.hideOtherSidebarContent || CONFIG.hideOtherSidebarContent + CONFIG.namespace = opts.namespace || CONFIG.namespace + } + + const isAuto = CONFIG.paths === 'auto' + + hook.mounted(_ => { + initComponet(CONFIG, vm) + !isAuto && initSearch(CONFIG, vm) + }) + hook.doneEach(_ => { + updateComponent(CONFIG, vm) + isAuto && initSearch(CONFIG, vm) + }) +} + +$docsify.plugins = [].concat(install, $docsify.plugins) diff --git a/src/plugins/search/search.js b/src/plugins/search/search.js new file mode 100644 index 0000000..2c9febf --- /dev/null +++ b/src/plugins/search/search.js @@ -0,0 +1,193 @@ +let INDEXS = {} + +const LOCAL_STORAGE = { + EXPIRE_KEY: 'docsify.search.expires', + INDEX_KEY: 'docsify.search.index' +} + +function resolveExpireKey(namespace) { + return namespace ? `${LOCAL_STORAGE.EXPIRE_KEY}/${namespace}` : LOCAL_STORAGE.EXPIRE_KEY +} +function resolveIndexKey(namespace) { + return namespace ? `${LOCAL_STORAGE.INDEX_KEY}/${namespace}` : LOCAL_STORAGE.INDEX_KEY +} + +function escapeHtml(string) { + const entityMap = { + '&': '&', + '<': '<', + '>': '>', + '"': '"', + '\'': ''', + '/': '/' + } + + return String(string).replace(/[&<>"'/]/g, s => entityMap[s]) +} + +function getAllPaths(router) { + const paths = [] + + Docsify.dom.findAll('.sidebar-nav a:not(.section-link):not([data-nosearch])').forEach(node => { + const href = node.href + const originHref = node.getAttribute('href') + const path = router.parse(href).path + + if ( + path && + paths.indexOf(path) === -1 && + !Docsify.util.isAbsolutePath(originHref) + ) { + paths.push(path) + } + }) + + return paths +} + +function saveData(maxAge, expireKey, indexKey) { + localStorage.setItem(expireKey, Date.now() + maxAge) + localStorage.setItem(indexKey, JSON.stringify(INDEXS)) +} + +export function genIndex(path, content = '', router, depth) { + const tokens = window.marked.lexer(content) + const slugify = window.Docsify.slugify + const index = {} + let slug + + tokens.forEach(token => { + if (token.type === 'heading' && token.depth <= depth) { + slug = router.toURL(path, {id: slugify(token.text)}) + index[slug] = {slug, title: token.text, body: ''} + } else { + if (!slug) { + return + } + if (!index[slug]) { + index[slug] = {slug, title: '', body: ''} + } else if (index[slug].body) { + index[slug].body += '\n' + (token.text || '') + } else { + index[slug].body = token.text + } + } + }) + slugify.clear() + return index +} + +/** + * @param {String} query + * @returns {Array} + */ +export function search(query) { + const matchingResults = [] + let data = [] + Object.keys(INDEXS).forEach(key => { + data = data.concat(Object.keys(INDEXS[key]).map(page => INDEXS[key][page])) + }) + + query = query.trim() + let keywords = query.split(/[\s\-，\\/]+/) + if (keywords.length !== 1) { + keywords = [].concat(query, keywords) + } + + for (let i = 0; i < data.length; i++) { + const post = data[i] + let matchesScore = 0 + let resultStr = '' + const postTitle = post.title && post.title.trim() + const postContent = post.body && post.body.trim() + const postUrl = post.slug || '' + + if (postTitle) { + keywords.forEach( keyword => { + // From https://github.com/sindresorhus/escape-string-regexp + const regEx = new RegExp( + keyword.replace(/[|\\{}()[\]^$+*?.]/g, '\\$&'), + 'gi' + ); + let indexTitle = -1 + let indexContent = -1 + + indexTitle = postTitle ? postTitle.search(regEx) : -1 + indexContent = postContent ? postContent.search(regEx) : -1 + + if (indexTitle >= 0 || indexContent >= 0) { + matchesScore += indexTitle >= 0 ? 3 : indexContent >= 0 ? 2 : 0; + if (indexContent < 0) { + indexContent = 0 + } + + let start = 0 + let end = 0 + + start = indexContent < 11 ? 0 : indexContent - 10 + end = start === 0 ? 70 : indexContent + keyword.length + 60 + + if (end > postContent.length) { + end = postContent.length + } + + const matchContent = + '...' + + escapeHtml(postContent) + .substring(start, end) + .replace(regEx, `${keyword}`) + + '...' + + resultStr += matchContent + } + }) + + if (matchesScore > 0) { + const matchingPost = { + title: escapeHtml(postTitle), + content: postContent ? resultStr : '', + url: postUrl, + score: matchesScore + } + + matchingResults.push(matchingPost) + } + } + } + + return matchingResults.sort((r1, r2) => r2.score - r1.score); +} + +export function init(config, vm) { + const isAuto = config.paths === 'auto' + + const expireKey = resolveExpireKey(config.namespace) + const indexKey = resolveIndexKey(config.namespace) + + const isExpired = localStorage.getItem(expireKey) < Date.now() + + INDEXS = JSON.parse(localStorage.getItem(indexKey)) + + if (isExpired) { + INDEXS = {} + } else if (!isAuto) { + return + } + + const paths = isAuto ? getAllPaths(vm.router) : config.paths + const len = paths.length + let count = 0 + + paths.forEach(path => { + if (INDEXS[path]) { + return count++ + } + + Docsify + .get(vm.router.getFile(path), false, vm.config.requestHeaders) + .then(result => { + INDEXS[path] = genIndex(path, result, vm.router, config.depth) + len === ++count && saveData(config.maxAge, expireKey, indexKey) + }) + }) +} diff --git a/src/plugins/zoom-image.js b/src/plugins/zoom-image.js new file mode 100644 index 0000000..faf92e1 --- /dev/null +++ b/src/plugins/zoom-image.js @@ -0,0 +1,21 @@ +import mediumZoom from 'medium-zoom' + +const matchesSelector = Element.prototype.matches || Element.prototype.webkitMatchesSelector || Element.prototype.msMatchesSelector + +function install(hook) { + let zoom + + hook.doneEach(_ => { + let elms = Array.apply(null, document.querySelectorAll('.markdown-section img:not(.emoji):not([data-no-zoom])')) + + elms = elms.filter(elm => matchesSelector.call(elm, 'a img') === false) + + if (zoom) { + zoom.detach() + } + + zoom = mediumZoom(elms) + }) +} + +$docsify.plugins = [].concat(install, $docsify.plugins) diff --git a/src/render.js b/src/render.js deleted file mode 100644 index 75bed94..0000000 --- a/src/render.js +++ /dev/null @@ -1,203 +0,0 @@ -import marked from 'marked' -import Prism from 'prismjs' -import * as tpl from './tpl' -import { activeLink, scrollActiveSidebar, bindToggle, scroll2Top, sticky } from './event' -import { genTree, getRoute, isMobile } from './util' - -let OPTIONS = {} -const CACHE = {} - -const renderTo = function (dom, content) { - dom = typeof dom === 'object' ? dom : document.querySelector(dom) - dom.innerHTML = content - - return dom -} -let toc = [] -const renderer = new marked.Renderer() - -/** - * render anchor tag - * @link https://github.com/chjj/marked#overriding-renderer-methods - */ -renderer.heading = function (text, level) { - const slug = text.toLowerCase() - .replace(/<(?:.|\n)*?>/gm, '') - .replace(/[^\w|\u4e00-\u9fa5]+/g, '-') - let route = '' - - if (OPTIONS.router) { - route = `#/${getRoute()}` - } - - toc.push({ level, slug: `${route}#${encodeURIComponent(slug)}`, title: text }) - - return `${hl}Time is money, my friend!
') + }) + + describe('lists', function() { + it('as unordered task list', async function() { + const {docsify, dom} = await init() + const output = docsify.compiler.compile(` +- [x] Task 1 +- [ ] Task 2 +- [ ] Task 3`) + expect(output, `text
+