docsify/docs
John Hildenbiddle 4ae87bb18b
build: v5 updates and refactors (#2428)
* Update JS build

- Change rollup build from API to config file
- Change output dir from lib to dist
- Update lib to dist path in related files
- Update dependencies
- Add banner comment to bundles
- Add unminified plugin bundles

* Update docs with v5 version lock and dist path

* Update docs to reference minified themes

* Clean up docs

* Update CSS build

- Change CSS build from API to CLI
- Change output dir from lib to dist
- Update lib to dist path in related files
- Update dependencies
- Add sourcemaps

* Update dependencies

* Clean up package.json and add keywords

* Fix rimraf globs on Windows

* Fix PostCSS CLI glob on Windows

* Update test-related dependencies

* Update emoji

* Add engines prop to package.json
2024-05-21 15:19:21 -05:00
..
_images docs(en) finish 2017-02-13 22:43:58 +08:00
_media chore: fix front matter broken (#2390) 2024-03-22 09:37:28 +08:00
_coverpage.md [build] 4.13.0 2022-10-26 21:45:48 +08:00
_navbar.md docs: update the name for "Simplified Chinese" (#1811) 2022-06-03 13:29:52 +08:00
_sidebar.md refactor: delete the experimental and incomplete SSR feature 2023-06-25 12:03:44 -07:00
.nojekyll Add logo (#28) 2016-12-18 15:30:50 +08:00
cdn.md build: v5 updates and refactors (#2428) 2024-05-21 15:19:21 -05:00
CNAME add docsify.js.org 2016-11-28 12:22:47 +08:00
configuration.md Fix: Vue text interpolation in code blocks. (#2430) 2024-05-19 11:49:33 -05:00
cover.md build: v5 updates and refactors (#2428) 2024-05-21 15:19:21 -05:00
custom-navbar.md build: v5 updates and refactors (#2428) 2024-05-21 15:19:21 -05:00
deploy.md Fix: Vue text interpolation in code blocks. (#2430) 2024-05-19 11:49:33 -05:00
embed-files.md chore: fix front matter broken (#2390) 2024-03-22 09:37:28 +08:00
emoji.md build: v5 updates and refactors (#2428) 2024-05-21 15:19:21 -05:00
helpers.md fix: fix cross-origin links in history router mode (#1967) 2023-01-23 01:54:30 +08:00
index.html build: v5 updates and refactors (#2428) 2024-05-21 15:19:21 -05:00
language-highlight.md Ensure code format (#2138) 2023-08-09 17:53:30 +08:00
markdown.md Ensure code format (#2138) 2023-08-09 17:53:30 +08:00
more-pages.md build: v5 updates and refactors (#2428) 2024-05-21 15:19:21 -05:00
plugins.md build: v5 updates and refactors (#2428) 2024-05-21 15:19:21 -05:00
pwa.md Ensure code format (#2138) 2023-08-09 17:53:30 +08:00
quickstart.md build: v5 updates and refactors (#2428) 2024-05-21 15:19:21 -05:00
README.md chore: update miscellaneous parts of the source to reasonably modern language alternatives, remove polyfills, improve some JSDoc comments, remove traces of IE 2023-07-03 01:50:00 -07:00
themes.md build: v5 updates and refactors (#2428) 2024-05-21 15:19:21 -05:00
vue.md Fix: Vue text interpolation in code blocks. (#2430) 2024-05-19 11:49:33 -05:00
write-a-plugin.md chore: update miscellaneous parts of the source to reasonably modern language alternatives, remove polyfills, improve some JSDoc comments, remove traces of IE 2023-07-03 01:50:00 -07:00

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

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.