test/docsify
1
0
Fork 0
mirror of https://gitee.com/docsifyjs/docsify.git synced 2024-11-29 18:48:14 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
Migrated repository
1,247 Commits 35 Branches 194 Tags 25 MiB
JavaScript 87%
CSS 12.7%
Shell 0.2%
732c34db55
Go to file
Joe Pea 732c34db55 add editorconfig (tells editors which basic text format to use)
2020-05-22 01:29:36 -07:00
.github chore: update issue template for bug 2020-03-23 21:23:51 +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 Update nameLink option docs (#1125) 2020-04-19 21:02:07 +05:30
packages/docsify-server-renderer fix: upgrade docsify from 4.10.2 to 4.11.2 2020-03-31 21:31:48 +00:00
src add tests to make sure the global and plugin APIs are available and that configs can be functions 2020-05-22 01:28:34 -07:00
test add tests to make sure the global and plugin APIs are available and that configs can be functions 2020-05-22 01:28:34 -07:00
.editorconfig add editorconfig (tells editors which basic text format to use) 2020-05-22 01:29:36 -07:00
.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
.gitpod.yml [gitpod-setup] fix the preview opening issue. 2020-03-14 07:31:11 +00:00
.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.3 2020-03-25 14:27:53 +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: updated dep and docs 2020-03-25 13:35:34 +05:30
package.json v4.11.3 2020-03-24 20:08:55 +05:30
README.md [gitpod-setup] fix the preview opening issue. 2020-03-14 07:31:11 +00:00
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 Gitpod Ready-to-Code

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

Online one-click setup for Contributing

You can use Gitpod(A free online VS Code-like IDE) for contributing. With single click it'll launch a workspace and automatically:

  • clone the docsify repo.
  • install the dependencies.
  • start npm run dev.

So that you can start straight away.

Open in Gitpod

  • 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