Migrated repository
Go to file
2020-02-04 22:34:44 +05:30
.github chore(stale): added bug label to exemptlabels 2020-02-04 13:21:08 +05:30
.vscode chore: fixed the npm script and added css build file 2019-12-16 22:32:32 +05:30
build [build] 4.10.0 2019-12-16 22:58:51 +05:30
cypress [Test] : e2e tests using cypress (#999) 2020-01-30 17:44:13 +05:30
docs Eslint fixes for v4x (#989) 2019-12-30 22:01:46 +05:30
packages/docsify-server-renderer Eslint fixes for v4x (#989) 2019-12-30 22:01:46 +05:30
src Ensure autoHeader dom result is similar to parsed H1 (#811) 2020-02-04 22:34:44 +05:30
test Eslint fixes for v4x (#989) 2019-12-30 22:01:46 +05:30
.eslintignore [Test] : e2e tests using cypress (#999) 2020-01-30 17:44:13 +05:30
.eslintrc Eslint fixes for v4x (#989) 2019-12-30 22:01:46 +05:30
.gitignore [Test] : e2e tests using cypress (#999) 2020-01-30 17:44:13 +05:30
.npmignore update helper files 2017-03-18 17:21:59 +01:00
.travis.yml [Test] : e2e tests using cypress (#999) 2020-01-30 17:44:13 +05:30
CHANGELOG.md chore: add changelog 4.10.2 2019-12-17 03:20:41 +05:30
CONTRIBUTING.md chore: Activating Open Collective (#367) 2018-02-11 15:04:31 +08:00
cypress.json [Test] : e2e tests using cypress (#999) 2020-01-30 17:44:13 +05:30
HISTORY.md Fix typos (#326) 2017-12-16 12:06:12 +08:00
index.html align dev index.html to production 2019-05-05 18:50:31 +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 [Test] : e2e tests using cypress (#999) 2020-01-30 17:44:13 +05:30
package.json [Test] : e2e tests using cypress (#999) 2020-01-30 17:44:13 +05:30
README.md Readme: Improve outdated links to showcase 2019-05-05 18:50:31 +02: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