test/docsify
1
0
Fork 0
mirror of https://gitee.com/docsifyjs/docsify.git synced 2024-12-04 04:59:46 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
Migrated repository
1,220 Commits 35 Branches 194 Tags 25 MiB
JavaScript 87%
CSS 12.7%
Shell 0.2%
406670c3d6
Go to file
Anix 406670c3d6 fix: fixed rendering of color in coverpage issue
2020-03-09 20:30:01 +05:30
.github chore(CI): deleting snyk action as github doesnt allow tokens to forks 2020-03-05 01:16:06 +05:30
.vscode chore: documented __colon__ tip (#1025) 2020-02-14 20:41:53 +05:30
build [build] 4.10.0 2019-12-16 22:58:51 +05:30
cypress feat: new option hideSidebar (#1026) 2020-02-20 22:19:31 +05:30
docs [build] 4.11.1 2020-03-09 18:10:33 +05:30
packages/docsify-server-renderer [build] 4.11.1 2020-03-09 18:10:33 +05:30
src fix: fixed rendering of color in coverpage issue 2020-03-09 20:30:01 +05:30
test Adds option to specify an header height (#1045) 2020-03-09 14:19:31 +05:30
.eslintignore chore: added new linter config (#1028) 2020-02-20 14:01:04 +05:30
.eslintrc.js chore: added new linter config (#1028) 2020-02-20 14:01:04 +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
.prettierrc.js chore: added new linter config (#1028) 2020-02-20 14:01:04 +05:30
CHANGELOG.md chore: add changelog 4.11.1 2020-03-09 18:11:20 +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-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 chore: add changelog 4.11.1 2020-03-09 18:11:20 +05:30
package.json chore: add changelog 4.11.1 2020-03-09 18:11:20 +05:30
README.md chore(readme): added CI badges and fixed the logo issue 2020-02-14 16:00:41 +05:30
server.js chore: update german docs, fix links (#560) 2018-07-01 13:48:44 +08:00

README.md

docsify

A magical documentation site generator.

Backers on Open Collective Sponsors on Open Collective Unit tests Suite Linting Checks Testing the e2e test suites 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 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