You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
qingwei.li df84bc73ee chore: typo 6 years ago
..
_images docs(en) finish 7 years ago
_media docs: add embed files, resolve #383, resolve #333, resolve #134 6 years ago
de-de chore: typo 6 years ago
zh-cn chore: typo 6 years ago
.nojekyll Add logo (#28) 8 years ago
CNAME add docsify.js.org 8 years ago
README.md docs: update file size 6 years ago
_coverpage.md docs: update file size 6 years ago
_navbar.md feat(render): add mergeNavbar option, close #125, #124 (#145) 7 years ago
_sidebar.md docs: update file size 6 years ago
cdn.md docs(cdn): update jsdelivr cdn 7 years ago
configuration.md docs: add requestHeaders and ext 6 years ago
cover.md docs: update file size 6 years ago
custom-navbar.md docs: add mutiple covers 6 years ago
deploy.md Adding Firebase Hosting deployment documentation (#378) 6 years ago
embed-files.md chore: typo 6 years ago
helpers.md Fixed a little error (#379) 6 years ago
index.html chore: add google search meta 6 years ago
language-highlight.md Update language-highlight.md (#277) 7 years ago
markdown.md chore(docs): fix markdown demo 7 years ago
more-pages.md docs: add mutiple covers 6 years ago
plugins.md feat: add navigation plugin, closed #180 7 years ago
pwa.md update english docs 7 years ago
quickstart.md docs: update quickstart 6 years ago
ssr.md chore: Fix invalid package.json/HTML references (#345) 6 years ago
themes.md add German docs 7 years ago
vue.md docs: fix a broken code block (#286) 7 years ago
write-a-plugin.md docs(write-a-plugin): update demo 7 years ago

README.md

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.