docsify/docs
2020-10-21 13:14:07 -05: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.11.6 2020-08-22 19:37:00 +08:00
_navbar.md fix: Russian language link error (#1270) 2020-07-05 19:17:50 +08:00
_sidebar.md chore(docs): remove new badege 2018-10-31 21:15:07 +08:00
.nojekyll Add logo (#28) 2016-12-18 15:30:50 +08:00
cdn.md docs: update other cdn (#1325) 2020-08-02 12:09:08 +08:00
CNAME add docsify.js.org 2016-11-28 12:22:47 +08:00
configuration.md Rename vueOptions to vueMountOptions 2020-10-21 13:14:07 -05:00
cover.md docs: remove bundle size from the home page and documentation (#1257) 2020-07-02 21:02:47 +05:30
custom-navbar.md changed the CDN from unpkg to jsDelivr #1020 (#1022) 2020-02-12 17:10:23 +05:30
deploy.md [documdocs: deploy docsify in docker. (#1241) 2020-06-23 12:41:31 +05:30
embed-files.md [Snyk] Security upgrade marked from 0.7.0 to 1.1.1 (#1313) 2020-08-14 07:53:23 +08:00
helpers.md docs: add crossOriginLinks configurations details. (#1386) 2020-10-08 07:00:08 +08:00
index.html Rename vueOptions to vueMountOptions 2020-10-21 13:14:07 -05:00
language-highlight.md Update language-highlight.md 2020-07-02 18:20:39 -05:00
markdown.md docs: mermaid duplicated id, see #504 (#685) 2018-11-06 17:27:24 +08:00
more-pages.md fix: convert {docsify-ignore} and {docsify-ignore-all} to HTML comments (#1318) 2020-07-30 18:11:04 +08:00
plugins.md update doc (#1381) 2020-10-03 09:34:17 +08:00
pwa.md changed the CDN from unpkg to jsDelivr #1020 (#1022) 2020-02-12 17:10:23 +05:30
quickstart.md fix: Updated docs with instructions for installing specific version (fixes #780) (#1225) 2020-06-23 22:41:20 +05:30
README.md docs: add vercel logo (#1267) 2020-07-04 16:02:16 +05:30
ssr.md Improve accessibility of viewport meta 2020-04-27 21:47:49 +01:00
themes.md changed the CDN from unpkg to jsDelivr #1020 (#1022) 2020-02-12 17:10:23 +05:30
vue.md Rename vueOptions to vueMountOptions 2020-10-21 13:14:07 -05:00
write-a-plugin.md Fix typo in Edit Button example 2019-04-06 00:11:54 +10: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 Gitter chat room.

Special Thanks

Vercel has given us a Pro account.