test/docsify
1
0
Fork 0
mirror of https://gitee.com/docsifyjs/docsify.git synced 2024-11-30 11:08:58 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity
Migrated repository
1,654 Commits 35 Branches 194 Tags 25 MiB
JavaScript 87%
CSS 12.7%
Shell 0.2%
898e6eea7a
Go to file
Koy Zhuang 898e6eea7a
chore(docs): docsify-ignore config polish. (#1994)
2023-02-23 16:01:11 +08:00
.codesandbox feat: Native emoji w/ image-based fallbacks and improved parsing (#1746) 2022-03-05 22:25:09 -06:00
.github chore: remove ci duplicated config (#1971) 2023-01-23 16:53:16 +08:00
.vscode refactor: Update test environments and lint configuration (#1736) 2022-01-30 21:40:21 -06:00
build feat: Emoji build (#1766) 2022-03-08 16:22:10 +08:00
docs chore(docs): docsify-ignore config polish. (#1994) 2023-02-23 16:01:11 +08:00
packages/docsify-server-renderer fix: upgrade node-fetch from 2.6.8 to 2.6.9 (#1996) 2023-02-22 13:17:46 +08:00
src fix: fix cross-origin links in history router mode (#1967) 2023-01-23 01:54:30 +08:00
test chore: add changelog v4.13.0 2022-10-26 21:50:32 +08: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 Virtual Routes Support (#1799) 2022-05-23 14:03:33 -07: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 v4.13.0 2022-10-26 21:50:32 +08:00
CONTRIBUTING.md chore: Update CONTRIBUTING.md (#1782) 2022-03-31 16:28:32 +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: Fix missing dolphin theme (#1960) 2023-01-10 16:02:02 +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 chore: bump http-cache-semantics from 4.1.0 to 4.1.1 (#1985) 2023-02-05 16:57:52 +08:00
package.json fix: upgrade medium-zoom from 1.0.7 to 1.0.8 (#1939) 2022-12-16 20:34:09 +08:00
playwright.config.js refactor: Update test environments and lint configuration (#1736) 2022-01-30 21:40:21 -06:00
README.md Improve README.md sentence (#1817) 2022-06-06 22:12:47 -07:00
sandbox.config.json feat: Native emoji w/ image-based fallbacks and improved parsing (#1746) 2022-03-05 22:25:09 -06: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 a 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

A preview of Docsify's PR and develop branch is Powered by Vercel