Skip to content
πŸƒ A magical documentation site generator.
Branch: master
Clone or download
timaschew Merge pull request #792 from gemmadlou/master
Docsify publishing with AWS Amplify steps
Latest commit d80aa21 Mar 16, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github chore: typo Feb 11, 2018
.vscode chore: add vscode config Oct 2, 2017
build fix: ssr package dep, fixed #605 Oct 31, 2018
docs Docsify publishing with AWS Amplify steps Mar 13, 2019
lib [build] 4.9.1 Feb 21, 2019
packages/docsify-server-renderer
src Merge pull request #784 from spiritree/hotfix/gitalk Mar 3, 2019
test rework TODOs Mar 6, 2019
.eslintignore refactor: build config (#408) Mar 3, 2018
.eslintrc refactor: build config (#408) Mar 3, 2018
.gitignore chore: fix 'dev' script failed Jul 5, 2018
.npmignore update helper files Mar 18, 2017
.travis.yml chore: update travisci Sep 6, 2017
CHANGELOG.md chore: add changelog 4.9.1 Feb 21, 2019
CONTRIBUTING.md
HISTORY.md Fix typos (#326) Dec 16, 2017
LICENSE Update LICENSE Dec 26, 2017
README.md docs: add codesandbox link Nov 1, 2018
index.html
lerna.json add lerna May 31, 2017
package-lock.json fix xhr usage, fix init URL setup Feb 25, 2019
package.json split test into unit and integration Feb 25, 2019
server.js chore: update german docs, fix links (#560) Jul 1, 2018

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

Links

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

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.