Migrated repository
Go to file
沈唁 2d13255acb
chore: update vercel logo (#1776)
* chore: update vercel logo

* chore: update vercel logo

* chore: remove vercel link form github pages

* chore: update style

* chore: update readme

* chore: update readme

* chore: update readme
2022-03-24 00:46:36 +08:00
.codesandbox feat: Native emoji w/ image-based fallbacks and improved parsing (#1746) 2022-03-05 22:25:09 -06:00
.github refactor: Update test environments and lint configuration (#1736) 2022-01-30 21:40:21 -06:00
.vscode refactor: Update test environments and lint configuration (#1736) 2022-01-30 21:40:21 -06:00
build feat: Emoji build (#1766) 2022-03-08 16:22:10 +08:00
docs chore: update vercel logo (#1776) 2022-03-24 00:46:36 +08:00
packages/docsify-server-renderer chore: Remove dompurify (#1490) 2022-03-08 07:45:23 -06:00
src docs: Update configuration options (#1773) 2022-03-18 10:52:29 -05:00
test Fix: ready/doneEach order with async afterEach (#1770) 2022-03-15 19:15:12 -05:00
.editorconfig add editorconfig (tells editors which basic text format to use) 2020-05-22 01:29:36 -07:00
.eslintignore refactor: Update test environments and lint configuration (#1736) 2022-01-30 21:40:21 -06:00
.eslintrc.js refactor: Update test environments and lint configuration (#1736) 2022-01-30 21:40:21 -06:00
.gitignore fix: Coverpage when content > viewport height (#1744) 2022-02-03 16:03:34 -06:00
.gitpod.yml [gitpod-setup] fix the preview opening issue. 2020-03-14 07:31:11 +00:00
.npmignore refactor: Update test environments and lint configuration (#1736) 2022-01-30 21:40:21 -06:00
.prettierrc.js refactor: Update test environments and lint configuration (#1736) 2022-01-30 21:40:21 -06:00
babel.config.js Jest + Playwright Testing (#1276) 2020-10-05 14:10:30 -05:00
CHANGELOG.md chore: add changelog 4.12.2 2022-01-06 16:55:27 +08:00
CONTRIBUTING.md chore: Activating Open Collective (#367) 2018-02-11 15:04:31 +08:00
Dockerfile test:docker locally. 2021-12-10 01:55:30 +08:00
HISTORY.md Fix typos (#326) 2017-12-16 12:06:12 +08:00
index.html chore: update vercel logo (#1776) 2022-03-24 00:46:36 +08:00
jest.config.js refactor: Update test environments and lint configuration (#1736) 2022-01-30 21:40:21 -06:00
lerna.json add lerna 2017-05-31 10:01:15 +08:00
LICENSE Update LICENSE 2022-01-16 19:52:18 -08:00
package-lock.json chore: Remove dompurify (#1490) 2022-03-08 07:45:23 -06:00
package.json chore: Remove dompurify (#1490) 2022-03-08 07:45:23 -06:00
playwright.config.js refactor: Update test environments and lint configuration (#1736) 2022-01-30 21:40:21 -06:00
README.md chore: update vercel logo (#1776) 2022-03-24 00:46:36 +08:00
sandbox.config.json feat: Native emoji w/ image-based fallbacks and improved parsing (#1746) 2022-03-05 22:25:09 -06:00
SECURITY.md Create SECURITY.md (#1634) 2021-09-10 13:57:38 +08:00
server.js Improve accessibility of viewport meta 2020-04-27 21:47:49 +01:00

docsify

A magical documentation site generator.

Backers on Open Collective Sponsors on Open Collective Build & Test npm donate Join Discord community and chat about Docsify Gitpod Ready-to-Code

Gold Sponsor via Open Collective

Features

  • No statically built html files
  • Simple and lightweight
  • Smart full-text search plugin
  • Multiple themes
  • Useful plugin API
  • Compatible with IE11
  • Experimental SSR support (example)
  • Support embedded files

Quick start

Look at this tutorial

Edit 307qqv236

Showcase

These projects are using docsify to generate their sites. Pull requests welcome 😊

Move to awesome-docsify

Similar projects

Project Description
docute 📜 Effortlessly documentation done right
docpress Documentation website generator

Contributing

Online one-click setup for Contributing

You can use Gitpod(A free online VS Code-like IDE) for contributing. With single click it'll launch a workspace and automatically:

  • clone the docsify repo.
  • install the dependencies.
  • start npm run dev.

So that you can start straight away.

Open in Gitpod

  • Fork it!
  • Create your feature branch: git checkout -b my-new-feature
  • Commit your changes: git add . && git commit -m 'Add some feature'
  • Push to the branch: git push origin my-new-feature
  • Submit a pull request

Development

npm run bootstrap && npm run dev

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

Contributors

This project exists thanks to all the people who contribute. [Contribute].

License

MIT

Special Thanks

A preview of Docsify's PR and develop branch is Powered by Vercel