yerf
/
docsify
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
1,499 Commits 35 Branches 193 Tags 53 MiB
JavaScript 90.4%
Stylus 7.9%
HTML 1.3%
Shell 0.3%
Go to file
sy-records a2132c89ea chore: add changelog 4.12.0 2021-02-08 09:21:43 +08:00
.codesandbox ci: added codesandbox build preview for PR reviews (#1193) 2020-06-08 13:07:07 +05:30
.github chore: Create issues config.yml (#1465) 2021-01-02 09:42:33 +08:00
.vscode Jest + Playwright Testing (#1276) 2020-10-05 14:10:30 -05:00
build [Snyk] Security upgrade marked from 0.7.0 to 1.1.1 (#1313) 2020-08-14 07:53:23 +08:00
docs [build] 4.12.0 2021-02-08 09:21:40 +08:00
packages/docsify-server-renderer [build] 4.12.0 2021-02-08 09:21:40 +08:00
src fix: Use legacy-compatible methods for IE11 (#1495) 2021-02-07 10:44:18 -06:00
test fix: Unable to navigate on server without default index support (#1372) 2021-02-07 10:25:37 -06:00
.editorconfig add editorconfig (tells editors which basic text format to use) 2020-05-22 01:29:36 -07:00
.eslintignore Jest + Playwright Testing (#1276) 2020-10-05 14:10:30 -05:00
.eslintrc.js Jest + Playwright Testing (#1276) 2020-10-05 14:10:30 -05:00
.gitignore Jest + Playwright Testing (#1276) 2020-10-05 14:10:30 -05:00
.gitpod.yml [gitpod-setup] fix the preview opening issue. 2020-03-14 07:31:11 +00:00
.npmignore update helper files 2017-03-18 17:21:59 +01:00
.prettierrc.js chore: added new linter config (#1028) 2020-02-20 14:01:04 +05:30
CHANGELOG.md chore: add changelog 4.12.0 2021-02-08 09:21:43 +08:00
CONTRIBUTING.md chore: Activating Open Collective (#367) 2018-02-11 15:04:31 +08:00
HISTORY.md Fix typos (#326) 2017-12-16 12:06:12 +08:00
LICENSE Update LICENSE 2017-12-26 18:01:57 +08:00
README.md Fix git commit typo (#1347) 2020-08-22 11:51:08 +08:00
babel.config.js Jest + Playwright Testing (#1276) 2020-10-05 14:10:30 -05:00
index.html Restore pathNamespaces 2021-02-04 18:53:14 -06:00
jest.config.js Remove BLANK_URL global 2020-11-11 16:57:22 -06:00
lerna.json add lerna 2017-05-31 10:01:15 +08:00
package-lock.json chore: add changelog 4.12.0 2021-02-08 09:21:43 +08:00
package.json chore: add changelog 4.12.0 2021-02-08 09:21:43 +08:00
server.js Improve accessibility of viewport meta 2020-04-27 21:47:49 +01:00

README.md

docsify

A magical documentation site generator.

Backers on Open Collective Sponsors on Open Collective Unit tests Suite Linting Checks Testing the e2e test suites npm donate gitter Gitpod Ready-to-Code

Gold Sponsor via Open Collective

Links

Features

  • No statically built html files
  • Simple and lightweight
  • Smart full-text search plugin
  • Multiple themes
  • Useful plugin API
  • Compatible with IE11
  • Support SSR (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

Vercel has given us a Pro account.