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,596 Commits 35 Branches 194 Tags 25 MiB
JavaScript 87%
CSS 12.7%
Shell 0.2%
pin-script-versions
Go to file
Koy Zhuang ccb7ea8d90
Merge branch 'develop' into pin-script-versions
2022-02-05 03:52:49 +08:00
.codesandbox ci: added codesandbox build preview for PR reviews (#1193) 2020-06-08 13:07:07 +05:30
.github refactor: Update test environments and lint configuration (#1736) 2022-01-30 21:40:21 -06:00
.vscode refactor: Update test environments and lint configuration (#1736) 2022-01-30 21:40:21 -06:00
build [Snyk] Security upgrade marked from 0.7.0 to 1.1.1 (#1313) 2020-08-14 07:53:23 +08:00
docs Merge branch 'develop' into pin-script-versions 2022-02-05 03:52:49 +08:00
packages/docsify-server-renderer Merge branch 'develop' into pin-script-versions 2022-02-05 03:52:49 +08:00
src chore: sync emojis (#1745) 2022-02-04 11:53:26 +08:00
test refactor: Update test environments and lint configuration (#1736) 2022-01-30 21:40:21 -06:00
.editorconfig add editorconfig (tells editors which basic text format to use) 2020-05-22 01:29:36 -07:00
.eslintignore refactor: Update test environments and lint configuration (#1736) 2022-01-30 21:40:21 -06:00
.eslintrc.js refactor: Update test environments and lint configuration (#1736) 2022-01-30 21:40:21 -06:00
.gitignore fix: Coverpage when content > viewport height (#1744) 2022-02-03 16:03:34 -06:00
.gitpod.yml [gitpod-setup] fix the preview opening issue. 2020-03-14 07:31:11 +00:00
.npmignore refactor: Update test environments and lint configuration (#1736) 2022-01-30 21:40:21 -06:00
.prettierrc.js refactor: Update test environments and lint configuration (#1736) 2022-01-30 21:40:21 -06:00
babel.config.js Jest + Playwright Testing (#1276) 2020-10-05 14:10:30 -05:00
CHANGELOG.md chore: add changelog 4.12.2 2022-01-06 16:55:27 +08:00
CONTRIBUTING.md chore: Activating Open Collective (#367) 2018-02-11 15:04:31 +08:00
Dockerfile test:docker locally. 2021-12-10 01:55:30 +08:00
HISTORY.md Fix typos (#326) 2017-12-16 12:06:12 +08:00
index.html add versions to all CDN link examples to prevent people from making websites that are at risk of breaking changes to Docsify, make it clear that the recommended approach is to use full versions in URLs, and fix formatting in any files that were modified 2022-01-23 19:34:30 -08:00
jest.config.js refactor: Update test environments and lint configuration (#1736) 2022-01-30 21:40:21 -06:00
lerna.json add lerna 2017-05-31 10:01:15 +08:00
LICENSE Update LICENSE 2022-01-16 19:52:18 -08:00
package-lock.json refactor: Update test environments and lint configuration (#1736) 2022-01-30 21:40:21 -06:00
package.json refactor: Update test environments and lint configuration (#1736) 2022-01-30 21:40:21 -06:00
playwright.config.js refactor: Update test environments and lint configuration (#1736) 2022-01-30 21:40:21 -06:00
README.md docs: update readme (#1740) 2022-02-02 17:50:20 +08:00
SECURITY.md Create SECURITY.md (#1634) 2021-09-10 13:57:38 +08:00
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 Build & Test npm donate Join Discord community and chat about Docsify 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
  • Experimental SSR support (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 add . && git commit -m '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.