test/docsify
1
0
Fork 0
mirror of https://gitee.com/docsifyjs/docsify.git synced 2024-11-30 02:58:37 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
5b6525b8f1
docsify/docs
History
qingwei.li 5b6525b8f1 [build] 4.8.5
2018-11-02 08:59:34 +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
_coverpage.md [build] 4.8.5 2018-11-02 08:59:34 +08:00
_navbar.md chore: add ru and es docs 2018-07-01 19:46:46 +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 Update cdn.md (#479) 2018-05-10 06:53:44 +08:00
CNAME add docsify.js.org 2016-11-28 12:22:47 +08:00
configuration.md chore: update german docs, fix links (#560) 2018-07-01 13:48:44 +08:00
cover.md chore: update file size 2018-10-31 22:17:55 +08:00
custom-navbar.md docs: add mutiple covers 2018-02-11 22:22:06 +08:00
deploy.md Fix VPS -> nginx deployment tips (#581) 2018-07-18 08:52:20 +08:00
embed-files.md chore: typo 2018-02-11 22:22:06 +08:00
helpers.md docs(helper): about markdown in html tag, fixed #655 fixed #667 2018-11-02 07:38:54 +08:00
index.html chore: add gitter sidecar 2018-07-20 11:01:10 +08:00
language-highlight.md Update language-highlight.md (#277) 2017-10-13 02:46:32 -05:00
markdown.md Update url to markedjs (#601) 2018-08-08 10:16:32 +08:00
more-pages.md Updated sidebar documentation to clarify nesting (#626) 2018-09-17 17:19:31 +08:00
plugins.md docs: add more plugins link" 2018-11-01 14:05:10 +08:00
pwa.md update english docs 2017-03-09 22:19:07 +01:00
quickstart.md chore: update german docs, fix links (#560) 2018-07-01 13:48:44 +08:00
README.md chore: update file size 2018-10-31 22:17:55 +08:00
ssr.md chore: update german docs, fix links (#560) 2018-07-01 13:48:44 +08:00
themes.md chore: update german docs, fix links (#560) 2018-07-01 13:48:44 +08:00
vue.md [docs][vue-demo][minor] add ID in div element (#506) 2018-10-23 15:29:35 +08:00
write-a-plugin.md fix: expose version info for Docsify, fixed #641 2018-11-02 08:53:46 +08:00

README.md

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 (~21kB gzipped)
  • Smart full-text search plugin
  • Multiple themes
  • Useful plugin API
  • Emoji support
  • Compatible with IE10+
  • 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.