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,580 Commits 35 Branches 194 Tags 25 MiB
JavaScript 87%
CSS 12.7%
Shell 0.2%
00a87311b0
Go to file
Joe Pea 00a87311b0 allow the el option to accept an HTMLElement instance 
This aligns it with what the docs were already saying erroneously, plus
this is useful in cases when people have refs to an element already
(embedding Docsify in a custom element shadow root, or in a React
component that has a ref to the target element, etc).
2022-01-05 09:55:48 -08:00
.codesandbox ci: added codesandbox build preview for PR reviews (#1193) 2020-06-08 13:07:07 +05:30
.github chore: fix microsoft/playwright-github-action error (#1534) 2021-03-11 16:13:08 +08:00
.vscode Jest + Playwright Testing (#1276) 2020-10-05 14:10:30 -05:00
build [Snyk] Security upgrade marked from 0.7.0 to 1.1.1 (#1313) 2020-08-14 07:53:23 +08:00
docs allow the el option to accept an HTMLElement instance 2022-01-05 09:55:48 -08:00
packages/docsify-server-renderer fix: upgrade debug from 4.3.2 to 4.3.3 (#1692) 2021-12-21 15:29:04 +08:00
src allow the el option to accept an HTMLElement instance 2022-01-05 09:55:48 -08:00
test allow the el option to accept an HTMLElement instance 2022-01-05 09:55:48 -08:00
.editorconfig add editorconfig (tells editors which basic text format to use) 2020-05-22 01:29:36 -07:00
.eslintignore Jest + Playwright Testing (#1276) 2020-10-05 14:10:30 -05:00
.eslintrc.js Jest + Playwright Testing (#1276) 2020-10-05 14:10:30 -05:00
.gitignore Jest + Playwright Testing (#1276) 2020-10-05 14:10:30 -05: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
babel.config.js Jest + Playwright Testing (#1276) 2020-10-05 14:10:30 -05:00
CHANGELOG.md chore: Update CHANGELOG and Update test snapshots 2021-03-07 11:09:40 +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 docs: add nameLink for change logo redirect. (#1651) 2021-10-15 14:11:56 +08:00
jest.config.js Remove BLANK_URL global 2020-11-11 16:57:22 -06: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] Upgrade dompurify from 2.3.0 to 2.3.1 (#1633) 2021-09-15 10:42:29 +08:00
package.json style: allow devs to test both build and tests at the same time (#1707) 2022-01-04 15:54:37 +08:00
README.md chore: change Gitter to Discord throughout project. (#1507) 2021-02-13 09:18:54 +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 Unit tests Suite Linting Checks Testing the e2e test suites 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
  • 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 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.