Migrated repository
Go to file
2019-11-23 21:36:34 +05:30
.github Update FUNDING.yml 2019-11-23 21:33:54 +05:30
.vscode chore: add vscode config 2017-10-02 13:26:45 +08:00
build fix: npm audit issues (#934) 2019-10-16 09:20:54 -04:00
docs Add deployment instructions for ZEIT Now 2019-11-21 09:27:50 -05:00
packages/docsify-server-renderer fix: npm audit issues (#934) 2019-10-16 09:20:54 -04:00
src improve emoji support (#930) 2019-11-22 13:09:51 -06:00
test IE compatibility and add unit tests 2019-03-25 17:20:09 +01:00
themes Create .gitkeep 2019-04-13 17:38:57 +02:00
.eslintignore refactor: build config (#408) 2018-03-03 22:51:27 +08:00
.eslintrc refactor: build config (#408) 2018-03-03 22:51:27 +08:00
.gitignore Cleanup gitignore 2019-05-05 18:12:20 +02:00
.npmignore update helper files 2017-03-18 17:21:59 +01:00
.travis.yml chore: update travisci 2017-09-06 18:25:56 +08:00
CHANGELOG.md chore: add changelog 4.9.4 2019-05-05 18:41:18 +02: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
index.html align dev index.html to production 2019-04-14 21:03:34 +02:00
lerna.json add lerna 2017-05-31 10:01:15 +08:00
LICENSE Update LICENSE 2017-12-26 18:01:57 +08:00
package-lock.json fix: npm audit issues (#934) 2019-10-16 09:20:54 -04:00
package.json fix: npm audit issues (#934) 2019-10-16 09:20:54 -04:00
README.md Readme: Improve outdated links to showcase 2019-04-26 11:25:17 +08:00
server.js chore: update german docs, fix links (#560) 2018-07-01 13:48:44 +08:00

docsify

A magical documentation site generator.

Backers on Open Collective Sponsors on Open Collective Travis Status npm donate gitter

Gold Sponsor via Open Collective

Features

  • No statically built html files
  • Simple and lightweight (~21kB gzipped)
  • 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

  • Fork it!
  • Create your feature branch: git checkout -b my-new-feature
  • Commit your changes: git commit -am '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

FOSSA Status