test/docsify
1
0
Fork 0
mirror of https://gitee.com/docsifyjs/docsify.git synced 2024-12-02 12:10:04 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
Migrated repository
1,361 Commits 35 Branches 194 Tags 25 MiB
JavaScript 87%
CSS 12.7%
Shell 0.2%
086c2859ad
Go to file
Snyk bot 086c2859ad
[Snyk] Security upgrade marked from 0.7.0 to 1.1.1 (#1313) 
* fix: package.json & package-lock.json to reduce vulnerabilities

The following vulnerabilities are fixed with an upgrade:
- https://snyk.io/vuln/SNYK-JS-MARKED-584281

* fix: fix CompileError

* fix: embed files error

Co-authored-by: Koy <369491420@qq.com>
Co-authored-by: 沈唁 <52o@qq52o.cn>
2020-08-14 07:53:23 +08:00
.codesandbox ci: added codesandbox build preview for PR reviews (#1193) 2020-06-08 13:07:07 +05:30
.github remove lib from pull request template as it is gitignored 2020-07-15 23:20:16 -07:00
.vscode chore: documented __colon__ tip (#1025) 2020-02-14 20:41:53 +05:30
build [Snyk] Security upgrade marked from 0.7.0 to 1.1.1 (#1313) 2020-08-14 07:53:23 +08:00
cypress fix: fallback page should use path not file location (#1301) 2020-08-04 14:47:03 +05:30
docs [Snyk] Security upgrade marked from 0.7.0 to 1.1.1 (#1313) 2020-08-14 07:53:23 +08:00
packages/docsify-server-renderer chore(deps): bump prismjs in /packages/docsify-server-renderer (#1332) 2020-08-09 07:25:38 +08:00
src [Snyk] Security upgrade marked from 0.7.0 to 1.1.1 (#1313) 2020-08-14 07:53:23 +08:00
test fix: convert {docsify-ignore} and {docsify-ignore-all} to HTML comments (#1318) 2020-07-30 18:11:04 +08: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 feat: added html sanitizer for remote rendering (#1128) 2020-06-17 23:55:59 +05:30
.gitignore fix: gitignore was ignoring folders in src, so VS Code search results or file fuzzy finder were not working, etc 2020-07-15 23:00:28 -07:00
.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.4 2020-06-18 23:48:00 +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 fix: {docsify-updated} in the sample code is parsed into time (#1321) 2020-08-01 17:04:08 +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 [Snyk] Security upgrade marked from 0.7.0 to 1.1.1 (#1313) 2020-08-14 07:53:23 +08:00
package.json [Snyk] Security upgrade marked from 0.7.0 to 1.1.1 (#1313) 2020-08-14 07:53:23 +08:00
README.md docs: add vercel logo (#1267) 2020-07-04 16:02:16 +05:30
server.js Improve accessibility of viewport meta 2020-04-27 21:47:49 +01: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
  • 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

Special Thanks

Vercel has given us a Pro account.