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
6b8773fbb0
docsify/docs
History
Steven 6b8773fbb0
Move instructions up
2019-11-21 09:13:36 -05:00
..
_images docs(en) finish 2017-02-13 22:43:58 +08:00
_media feat: Provide code fragments feature (#748) 2019-01-23 10:54:50 +08:00
_coverpage.md [build] 4.9.4 next 2019-05-05 18:50:31 +02: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 feat: allows relative path, fixed #590 2019-03-25 16:33:03 +01: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 Move instructions up 2019-11-21 09:13:36 -05:00
embed-files.md feat: Provide code fragments feature (#748) 2019-01-23 10:54:50 +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 provide plugin for matomo 2019-05-05 18:50:31 +02:00
language-highlight.md Update language-highlight.md (#277) 2017-10-13 02:46:32 -05:00
markdown.md docs: mermaid duplicated id, see #504 (#685) 2018-11-06 17:27:24 +08:00
more-pages.md document customising page title with sidebar 2019-01-05 19:19:54 +11:00
plugins.md feat(search-plugin): add namespace option (#706) 2018-12-05 10:29:44 +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 Readme: Improve outdated links to showcase 2019-05-05 18:50:31 +02:00
ssr.md fix error in ssr config example 2019-01-06 10:26:21 +11: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 typo in Edit Button example 2019-04-06 00:11:54 +10: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 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.