test/docsify
1
0
Fork 0
mirror of https://gitee.com/docsifyjs/docsify.git synced 2024-11-29 18:48:14 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
63b2535a45
docsify/docs
History
John Hildenbiddle 63b2535a45
feat: Plugin error handling (#1742)
2022-03-15 00:18:50 -05: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 [build] 4.12.2 2022-01-06 16:55:22 +08:00
_navbar.md Add label translations (ru, es) 2021-02-04 14:47:17 -06:00
_sidebar.md feat: Native emoji w/ image-based fallbacks and improved parsing (#1746) 2022-03-05 22:25:09 -06:00
.nojekyll Add logo (#28) 2016-12-18 15:30:50 +08:00
cdn.md docs: update other cdn (#1325) 2020-08-02 12:09:08 +08:00
CNAME add docsify.js.org 2016-11-28 12:22:47 +08:00
configuration.md feat: Plugin error handling (#1742) 2022-03-15 00:18:50 -05:00
cover.md docs: improve English wording (Getting Started/Customization) (#1617) 2021-07-30 10:18:00 +08:00
custom-navbar.md changed the CDN from unpkg to jsDelivr #1020 (#1022) 2020-02-12 17:10:23 +05:30
deploy.md docs: improve English wording (Guide) 2021-07-30 11:51:24 -05:00
embed-files.md docs: improve English wording (Guide) 2021-07-30 11:51:24 -05:00
emoji.md feat: Emoji build (#1766) 2022-03-08 16:22:10 +08:00
helpers.md docs: improve English wording (Guide) 2021-07-30 11:51:24 -05:00
index.html fix: Legacy bugs (styles, site plugin error, and dev server error) (#1743) 2022-02-05 03:21:50 -06:00
language-highlight.md docs: Add dynamic code block highlighting documentation (#1626) 2021-08-27 18:34:34 +08:00
markdown.md docs: improve English wording (Getting Started/Customization) (#1617) 2021-07-30 10:18:00 +08:00
more-pages.md docs: improve English wording (Getting Started/Customization) (#1617) 2021-07-30 10:18:00 +08:00
plugins.md feat: Native emoji w/ image-based fallbacks and improved parsing (#1746) 2022-03-05 22:25:09 -06:00
pwa.md docs: improve English wording (Guide) 2021-07-30 11:51:24 -05:00
quickstart.md feat: Native emoji w/ image-based fallbacks and improved parsing (#1746) 2022-03-05 22:25:09 -06:00
README.md docs: update readme (#1740) 2022-02-02 17:50:20 +08:00
ssr.md mention that SSR is experimental and incomplete, prevent people from using it thinking it is ready for prime time 2022-01-23 19:43:46 -08:00
themes.md fix: theme switcher in IE11 (#1502) 2021-02-09 23:27:20 -06:00
vue.md docs: improve English wording (Guide) 2021-07-30 11:51:24 -05:00
write-a-plugin.md feat: Plugin error handling (#1742) 2022-03-15 00:18:50 -05: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 Discord server.

Special Thanks

Vercel has given us a Pro account.