jyapayne/docsify
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
docsify/docs
History
Nik Sudan 7dcebe7544 docs: Correct default value for routerMode (#549) 
This was `history` when it should have been set to `hash`. It also described the correct value in the example, which was misleading.

Please makes sure these boxes are checked before submitting your PR, thank you!

* [x] Make sure you are merging your commits to `master` branch.
* [x] Add some descriptions and refer relative issues for you PR.
* [x] DO NOT include files inside `lib` directory.
2018-06-25 21:17:02 +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 docs: add docsify-themable 2018-06-19 15:29:28 +08:00
zh-cn docs: add docsify-themable 2018-06-19 15:29:28 +08:00
.nojekyll Add logo (#28) 2016-12-18 15:30:50 +08:00
_coverpage.md [build] 4.6.10 2018-04-04 06:12:26 +09:00
_navbar.md Update _navbar.md 2018-05-23 15:26:28 +08:00
_sidebar.md fix typo 2018-02-23 11:56:12 +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 docs: Correct default value for routerMode (#549) 2018-06-25 21:17:02 +08:00
cover.md Fixed a typo in cover.md (#513) 2018-06-04 09:02:45 +08:00
custom-navbar.md docs: add mutiple covers 2018-02-11 22:22:06 +08:00
deploy.md docs: update netlify demo 2018-06-19 08:35:23 +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 upgrade docsify-plugin-codefund (#500) 2018-05-23 19:02:02 +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 chore: add codefund 2018-05-02 22:38:34 +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 docs: add docsify-themable 2018-06-19 15:29:28 +08: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

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