You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Anton Wilhelm f74b53f53e
Merge pull request #733 from jthegedus/master
5 years ago
.github chore: typo 6 years ago
.vscode chore: add vscode config 7 years ago
build fix: ssr package dep, fixed #605 5 years ago
docs Merge pull request #733 from jthegedus/master 5 years ago
lib [build] 4.9.1 5 years ago
packages/docsify-server-renderer [build] 4.9.1 5 years ago
src IE compatibility and add unit tests 5 years ago
test IE compatibility and add unit tests 5 years ago
.eslintignore refactor: build config (#408) 6 years ago
.eslintrc refactor: build config (#408) 6 years ago
.gitignore chore: fix 'dev' script failed 6 years ago
.npmignore update helper files 7 years ago
.travis.yml chore: update travisci 7 years ago
CHANGELOG.md chore: add changelog 4.9.1 5 years ago
CONTRIBUTING.md chore: Activating Open Collective (#367) 6 years ago
HISTORY.md Fix typos (#326) 6 years ago
LICENSE Update LICENSE 6 years ago
README.md docs: add codesandbox link 5 years ago
index.html chore: fix edit docs button, fixed #562 6 years ago
lerna.json add lerna 7 years ago
package-lock.json fix xhr usage, fix init URL setup 5 years ago
package.json split test into unit and integration 5 years ago
server.js chore: update german docs, fix links (#560) 6 years ago

README.md

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 IE10+
  • 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