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,547 Commits 35 Branches 194 Tags 25 MiB
JavaScript 87%
CSS 12.7%
Shell 0.2%
trusktr/wip-ssr-continue
Go to file
Joe Pea ac33596f45 TODO continue with these changes unstanged on the fix-validating-remote-content-2 branch
2021-09-26 15:52:50 -07: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 WIP adding tests for SSR 2020-11-01 23:45:36 -08:00
docs initial SSR working independently without a seconds server 2021-05-17 23:40:00 -07:00
packages/docsify-server-renderer initial SSR working independently without a seconds server 2021-05-17 23:40:00 -07:00
src TODO continue with these changes unstanged on the fix-validating-remote-content-2 branch 2021-09-26 15:52:50 -07:00
test Merge branch 'develop' into fix-validating-remote-content-2 2021-05-04 01:59:38 -07: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.cjs Merge branch 'develop' into fix-validating-remote-content-2 2021-05-04 01:59:38 -07:00
.gitignore remove package-lock files to fix CI error https://github.com/npm/npm/issues/17340 2021-05-04 02:14:34 -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.cjs WIP: update use native Node ESM for server code, update config files to specifically use .cjs (those tools don't support Node ESM files yet), use a single eslintrc file, all test code uses ESM import/export syntax instead of require (WIP) 2021-05-04 00:08:36 -07:00
babel.config.cjs WIP: update use native Node ESM for server code, update config files to specifically use .cjs (those tools don't support Node ESM files yet), use a single eslintrc file, all test code uses ESM import/export syntax instead of require (WIP) 2021-05-04 00:08:36 -07: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
HISTORY.md Fix typos (#326) 2017-12-16 12:06:12 +08:00
index.html chore: Update Edit Document using develop branch (#1541) 2021-04-18 16:14:33 +08:00
jest.config.js Merge branch 'develop' into fix-validating-remote-content-2 2021-05-04 01:59:38 -07: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.json initial SSR working independently without a seconds server 2021-05-17 23:40:00 -07:00
README.md chore: change Gitter to Discord throughout project. (#1507) 2021-02-13 09:18:54 +08:00
server.js TODO continue with these changes unstanged on the fix-validating-remote-content-2 branch 2021-09-26 15:52:50 -07: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.