docsify/docs
Romain Lenzotti 9b3b4454de feat(config): Add 404 page options. (#406)
This feature add the notFoundPage options to customize the default 404 page
with a markdown file. It also support the localisation.
2018-03-03 22:09:01 +08:00
..
_images docs(en) finish 2017-02-13 22:43:58 +08:00
_media docs: add embed files, resolve #383, resolve #333, resolve #134 2018-02-11 22:22:06 +08:00
de-de feat(config): Add 404 page options. (#406) 2018-03-03 22:09:01 +08:00
zh-cn feat(config): Add 404 page options. (#406) 2018-03-03 22:09:01 +08:00
_coverpage.md [build] 4.6.4 2018-03-01 22:42:48 +08:00
_navbar.md feat(render): add mergeNavbar option, close #125, #124 (#145) 2017-04-09 12:10:37 +08:00
_sidebar.md fix typo 2018-02-23 11:56:12 +08:00
.nojekyll Add logo (#28) 2016-12-18 15:30:50 +08:00
cdn.md docs(cdn): update jsdelivr cdn 2017-06-01 10:29:12 +08:00
CNAME add docsify.js.org 2016-11-28 12:22:47 +08:00
configuration.md feat(config): Add 404 page options. (#406) 2018-03-03 22:09:01 +08:00
cover.md docs: update file size 2018-02-11 22:22:06 +08:00
custom-navbar.md docs: add mutiple covers 2018-02-11 22:22:06 +08:00
deploy.md Adding Firebase Hosting deployment documentation (#378) 2018-02-04 19:06:04 +08:00
embed-files.md chore: typo 2018-02-11 22:22:06 +08:00
helpers.md chore: update helpers 2018-02-11 22:22:06 +08:00
index.html chore: add docsify link 2018-02-11 22:22:06 +08:00
language-highlight.md Update language-highlight.md (#277) 2017-10-13 02:46:32 -05:00
markdown.md chore(docs): fix markdown demo 2017-08-17 17:18:41 +08:00
more-pages.md docs: add mutiple covers 2018-02-11 22:22:06 +08:00
plugins.md feat: add navigation plugin, closed #180 2017-12-14 23:09:11 +08:00
pwa.md update english docs 2017-03-09 22:19:07 +01:00
quickstart.md docs: update quickstart 2018-01-03 09:56:15 +08:00
README.md docs: update file size 2018-02-11 22:22:06 +08:00
ssr.md fix typo 2018-02-23 11:56:51 +08:00
themes.md add German docs 2017-03-11 22:13:25 +01:00
vue.md docs: fix a broken code block (#286) 2017-10-20 09:41:38 -05:00
write-a-plugin.md docs(write-a-plugin): update demo 2017-05-31 08:39:01 +08:00

docsify

A magical documentation site generator.

What is it

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 website. All you need to do is create an index.html to start and deploy it on GitHub Pages.

See the Quick start for more details.

Features

  • No statically built html files
  • Simple and lightweight (~19kB gzipped)
  • Smart full-text search plugin
  • Multiple themes
  • Useful plugin API
  • Emoji support
  • Compatible with IE10+

Examples

Check out the Showcase to 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. ❤️