test/docsify
1
0
Fork 0
mirror of https://gitee.com/docsifyjs/docsify.git synced 2024-12-02 03:59:19 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
2a52460a59
docsify/docs
History
沈唁 2a52460a59
fix: Russian language link error (#1270)
2020-07-05 19:17:50 +08:00
..
_images docs(en) finish 2017-02-13 22:43:58 +08:00
_media docs: add vercel logo (#1267) 2020-07-04 16:02:16 +05:30
_coverpage.md docs: remove bundle size from the home page and documentation (#1257) 2020-07-02 21:02:47 +05:30
_navbar.md fix: Russian language link error (#1270) 2020-07-05 19:17:50 +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 changed the CDN from unpkg to jsDelivr #1020 (#1022) 2020-02-12 17:10:23 +05:30
CNAME add docsify.js.org 2016-11-28 12:22:47 +08:00
configuration.md Merge branch 'develop' into allow-config-function 2020-06-07 14:10:57 -07:00
cover.md docs: remove bundle size from the home page and documentation (#1257) 2020-07-02 21:02:47 +05:30
custom-navbar.md changed the CDN from unpkg to jsDelivr #1020 (#1022) 2020-02-12 17:10:23 +05:30
deploy.md [documdocs: deploy docsify in docker. (#1241) 2020-06-23 12:41:31 +05:30
embed-files.md docs: Add embed gist instructions to Embed Files (fixes #932 ) (#1238) 2020-06-22 23:10:26 +05:30
helpers.md fix: cross-origin url cannot be redirected when "externalLinkTarget" is set to "_self" and "routerMode" is set to "history". (#1062) 2020-05-15 11:00:36 +05:30
index.html fix: Russian language link error (#1270) 2020-07-05 19:17:50 +08:00
language-highlight.md changed the CDN from unpkg to jsDelivr #1020 (#1022) 2020-02-12 17:10:23 +05:30
markdown.md docs: mermaid duplicated id, see #504 (#685) 2018-11-06 17:27:24 +08:00
more-pages.md changed the CDN from unpkg to jsDelivr #1020 (#1022) 2020-02-12 17:10:23 +05:30
plugins.md docs: removed codefund docs and plugin (#1262) 2020-07-02 21:33:13 +05:30
pwa.md changed the CDN from unpkg to jsDelivr #1020 (#1022) 2020-02-12 17:10:23 +05:30
quickstart.md fix: Updated docs with instructions for installing specific version (fixes #780) (#1225) 2020-06-23 22:41:20 +05:30
README.md docs: add vercel logo (#1267) 2020-07-04 16:02:16 +05:30
ssr.md Improve accessibility of viewport meta 2020-04-27 21:47:49 +01:00
themes.md changed the CDN from unpkg to jsDelivr #1020 (#1022) 2020-02-12 17:10:23 +05:30
vue.md changed the CDN from unpkg to jsDelivr #1020 (#1022) 2020-02-12 17:10:23 +05:30
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
  • 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.

Special Thanks

Vercel has given us a Pro account.