Migrated repository
Go to file
Gemma Black 21cde83949
Docsify publishing with AWS Amplify steps
This is to help users be able to publish Docsify with AWS Amplify, so they don't get stuck on redirect rules and hash state issues.
2019-03-13 11:39:54 +00:00
.github chore: typo 2018-02-11 22:22:06 +08:00
.vscode chore: add vscode config 2017-10-02 13:26:45 +08:00
build fix: ssr package dep, fixed #605 2018-10-31 21:11:06 +08:00
docs Docsify publishing with AWS Amplify steps 2019-03-13 11:39:54 +00:00
lib [build] 4.9.1 2019-02-21 17:26:40 +08:00
packages/docsify-server-renderer [build] 4.9.1 2019-02-21 17:26:40 +08:00
src Merge pull request #784 from spiritree/hotfix/gitalk 2019-03-03 14:20:31 +01:00
test rework TODOs 2019-03-06 21:53:09 +01: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 chore: fix 'dev' script failed 2018-07-05 17:54:13 +08: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.1 2019-02-21 17:26:41 +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
index.html chore: fix edit docs button, fixed #562 2018-07-05 17:48:05 +08: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 xhr usage, fix init URL setup 2019-02-25 07:14:00 +01:00
package.json split test into unit and integration 2019-02-25 07:14:00 +01:00
README.md docs: add codesandbox link 2018-11-01 17:59:03 +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 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