docsify/docs
2022-02-05 03:52:49 +08:00
..
_images docs(en) finish 2017-02-13 22:43:58 +08:00
_media docs: add vercel logo (#1267) 2020-07-04 16:02:16 +05:30
_coverpage.md [build] 4.12.2 2022-01-06 16:55:22 +08:00
_navbar.md Add label translations (ru, es) 2021-02-04 14:47:17 -06:00
_sidebar.md docs: improve English wording (Guide) 2021-07-30 11:51:24 -05:00
.nojekyll Add logo (#28) 2016-12-18 15:30:50 +08:00
cdn.md add versions to all CDN link examples to prevent people from making websites that are at risk of breaking changes to Docsify, make it clear that the recommended approach is to use full versions in URLs, and fix formatting in any files that were modified 2022-01-23 19:34:30 -08:00
CNAME add docsify.js.org 2016-11-28 12:22:47 +08:00
configuration.md docs: update noCompileLinks documentation (#1666) 2021-11-19 17:19:45 +08:00
cover.md add versions to all CDN link examples to prevent people from making websites that are at risk of breaking changes to Docsify, make it clear that the recommended approach is to use full versions in URLs, and fix formatting in any files that were modified 2022-01-23 19:34:30 -08:00
custom-navbar.md add versions to all CDN link examples to prevent people from making websites that are at risk of breaking changes to Docsify, make it clear that the recommended approach is to use full versions in URLs, and fix formatting in any files that were modified 2022-01-23 19:34:30 -08:00
deploy.md docs: improve English wording (Guide) 2021-07-30 11:51:24 -05:00
embed-files.md docs: improve English wording (Guide) 2021-07-30 11:51:24 -05:00
helpers.md docs: improve English wording (Guide) 2021-07-30 11:51:24 -05:00
index.html add versions to all CDN link examples to prevent people from making websites that are at risk of breaking changes to Docsify, make it clear that the recommended approach is to use full versions in URLs, and fix formatting in any files that were modified 2022-01-23 19:34:30 -08:00
language-highlight.md add versions to all CDN link examples to prevent people from making websites that are at risk of breaking changes to Docsify, make it clear that the recommended approach is to use full versions in URLs, and fix formatting in any files that were modified 2022-01-23 19:34:30 -08:00
markdown.md add versions to all CDN link examples to prevent people from making websites that are at risk of breaking changes to Docsify, make it clear that the recommended approach is to use full versions in URLs, and fix formatting in any files that were modified 2022-01-23 19:34:30 -08:00
more-pages.md add versions to all CDN link examples to prevent people from making websites that are at risk of breaking changes to Docsify, make it clear that the recommended approach is to use full versions in URLs, and fix formatting in any files that were modified 2022-01-23 19:34:30 -08:00
plugins.md add versions to all CDN link examples to prevent people from making websites that are at risk of breaking changes to Docsify, make it clear that the recommended approach is to use full versions in URLs, and fix formatting in any files that were modified 2022-01-23 19:34:30 -08:00
pwa.md docs: improve English wording (Guide) 2021-07-30 11:51:24 -05:00
quickstart.md add versions to all CDN link examples to prevent people from making websites that are at risk of breaking changes to Docsify, make it clear that the recommended approach is to use full versions in URLs, and fix formatting in any files that were modified 2022-01-23 19:34:30 -08:00
README.md docs: update readme (#1740) 2022-02-02 17:50:20 +08:00
ssr.md Merge branch 'develop' into pin-script-versions 2022-01-26 09:07:53 -08:00
themes.md add versions to all CDN link examples to prevent people from making websites that are at risk of breaking changes to Docsify, make it clear that the recommended approach is to use full versions in URLs, and fix formatting in any files that were modified 2022-01-23 19:34:30 -08:00
vue.md add versions to all CDN link examples to prevent people from making websites that are at risk of breaking changes to Docsify, make it clear that the recommended approach is to use full versions in URLs, and fix formatting in any files that were modified 2022-01-23 19:34:30 -08:00
write-a-plugin.md docs: update formatUpdated (#1645) 2021-10-06 13:49:56 +08:00

docsify

A magical documentation site generator.

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.

See the Quick start guide for more details.

Features

  • No statically built html files
  • Simple and lightweight
  • Smart full-text search plugin
  • Multiple themes
  • Useful plugin API
  • Emoji support
  • Compatible with IE11
  • Support server-side rendering (example)

Examples

Check out the Showcase to see docsify in use.

Donate

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. ❤️

Community

Users and the development team are usually in the Discord server.

Special Thanks

Vercel has given us a Pro account.