Commit Graph

24 Commits

Author SHA1 Message Date
Joe Pea
7bbf13d9bd
Ensure code format (#2138)
* chore: add missing Vue support for Vercel builds

* refactor: move some functions and module-level state into classes as private methods and properties to start to encapsulate Docsify

Also some small tweaks:

- move initGlobalAPI out of Docsify.js to start to encapsulate Docsify
- move ajax to utils folder
- fix some type definitions and improve content in some JSDoc comments
- use concise class field syntax
- consolidate duplicate docsify-ignore comment removal code

This handles a task in [Simplify and modernize Docsify](https://github.com/docsifyjs/docsify/issues/2104), as well as works towards [Encapsulating Docsify](https://github.com/docsifyjs/docsify/issues/2135).

* chore: add prettier code format check to our lint script, and add a prettier script for manually formatting the whole code base

* chore: update issue/pr templates

* chore: apply our format to the whole code base


---------

Co-authored-by: Koy <koy@ko8e24.top>
Co-authored-by: i544693 <369491420@qq.com>
2023-08-09 17:53:30 +08:00
Koy Zhuang
898e6eea7a
chore(docs): docsify-ignore config polish. (#1994) 2023-02-23 16:01:11 +08:00
John Jago
97806cb757
docs: improve English wording (Getting Started/Customization) (#1617)
While referencing the documentation, I noticed a few phrases that could
be changed to sound more natural. I tried to keep the original meanings.
2021-07-30 10:18:00 +08:00
Mattia Astorino
90d283d340
fix: convert {docsify-ignore} and {docsify-ignore-all} to HTML comments (#1318)
* breaking: convert {docsify-ignore} and {docsify-ignore-all} to HTML comments

Close https://github.com/docsifyjs/docsify/issues/441

* chore: add ignore and ignore-all unit tests

Co-authored-by: 沈唁 <52o@qq52o.cn>
2020-07-30 18:11:04 +08:00
Anirudh Emmadi
0268594f90
docs: added file structure docs for sidebar (fixes #1083) (#1261)
* Added file structure docs for sidebar

* More specificity added

Co-authored-by: Anix <anik220798@gmail.com>

* More specificity added

Co-authored-by: Anix <anik220798@gmail.com>

Co-authored-by: Anix <anik220798@gmail.com>
2020-07-07 11:00:19 +05:30
orama254
d798a12715
changed the CDN from unpkg to jsDelivr #1020 (#1022)
* changed the CDN from unpkg to jsDelivr #1020

* tweaks after code review of PR #1022 for issue #1020
2020-02-12 17:10:23 +05:30
Gaurav Nelson
84384eeab3
Fixes documentation for page routes
Fixes #753
2019-06-19 13:34:26 +10:00
jthegedus
99dbaa3050 document customising page title with sidebar 2019-01-05 19:19:54 +11:00
Ciel
b0179e4c64 Updated sidebar documentation to clarify nesting (#626)
The documentation for how to create nested sidebars was unclear, and I could not find it anywhere else. After experimenting, I discovered the tactic and felt it should be in the docs.
2018-09-17 17:19:31 +08:00
Johannes Rappen
73a38c3878 chore: update german docs, fix links (#560)
* updated german links
* fixed links where `QingWei-Li` should've been `docsifyjs`
  * naturally excluded donate links and links to private projects like `vuep` unrelated to docsify

---

See commit for details. If you have a question, just ask.
2018-07-01 13:48:44 +08:00
qingwei.li
4bdcee2cb3 docs: add mutiple covers 2018-02-11 22:22:06 +08:00
qingwei.li
bedc262d83 docs: update alias fixed #372 2018-01-31 13:13:16 +08:00
Michal Stefanow
c17d892d30 Explaining the behaviour, closes #328 (#329) 2017-12-24 19:06:45 +08:00
Li Xueli
cc98f56cdd fix: {docsify-ignore-all} and {docsify-ignore} bug (#299)
* fix {docsify-ignore-all} not work bug

* fix {docsify-ignore} bug
2017-10-31 08:19:48 -05:00
Li Xueli
752f68e5f8 chore: {docsify-ignore-all} not working properly (#298) 2017-10-31 03:11:40 -05:00
gpresland
bab76e004d Pretty dir tree 2017-05-22 08:03:42 +08:00
qingwei.li
8f11653b41 feat(route): auto remove .md extension 2017-03-25 15:52:21 +08:00
Chris Anselmo
d57b80e224 Add ability to ignore headers when generating toc (#127)
* Added ability to ignore some or all headings when generating toc in sidebar

* Added documentation for ignoring sub headers

* Fixed minor test issues
2017-03-15 15:50:26 +08:00
Johannes Rappen
6eada5a2f7 update english docs 2017-03-09 22:19:07 +01:00
gpresland
d6b5403982 Update dictory structure in more-pages.md (#113)
Cleaner unicode structure.
2017-03-04 14:53:22 +08:00
qingwei.li
b4fc6a9d72 fix typo 2017-02-21 14:05:58 +08:00
Jintzo
feb4b89461 Update docs: Getting started (#85)
* fixed look of links in blockquote

* updated main README

* updated getting started

* updated more-pages

* make custom sidebar loading clear

* updated custom navbar

* added markdown comments

* updated cover documentation

* updated cover page

* updated sidebar
2017-02-21 14:04:16 +08:00
qingwei.li
7c6ab54ba7 docs(en) finish 2017-02-13 22:43:58 +08:00
qingwei.li
68c70509d1 docs(en) init english documents 2017-02-12 22:22:33 +08:00