Migrated repository
Go to file
2024-05-23 22:15:25 -05:00
.github chore: bump actions/upload-artifact from 3 to 4 (#2350) 2024-01-08 16:40:06 +08:00
.husky fix: husky can not auto install issue after upgrade. (#2325) 2024-01-17 22:49:35 +08:00
.vscode refactor: convert to ES Modules and remove traces of CommonJS except in Rollup config because some dependencies are still CommonJS 2023-06-29 19:02:08 -07:00
build build: v5 updates and refactors (#2428) 2024-05-21 15:19:21 -05:00
docs build: v5 updates and refactors (#2428) 2024-05-21 15:19:21 -05:00
src chore: Update marked dependency (4 => 12) (#2439) 2024-05-23 22:15:25 -05:00
test build: v5 updates and refactors (#2428) 2024-05-21 15:19:21 -05:00
.editorconfig add editorconfig (tells editors which basic text format to use) 2020-05-22 01:29:36 -07:00
.eslintignore build: v5 updates and refactors (#2428) 2024-05-21 15:19:21 -05:00
.eslintrc.cjs refactor: convert to ES Modules and remove traces of CommonJS except in Rollup config because some dependencies are still CommonJS 2023-06-29 19:02:08 -07:00
.gitattributes chore: create .gitattributes(#2288) 2023-10-23 04:03:53 +08:00
.gitignore build: v5 updates and refactors (#2428) 2024-05-21 15:19:21 -05:00
.gitpod.yml Ensure code format (#2138) 2023-08-09 17:53:30 +08:00
.npmignore refactor: convert to ES Modules and remove traces of CommonJS except in Rollup config because some dependencies are still CommonJS 2023-06-29 19:02:08 -07:00
.prettierignore build: v5 updates and refactors (#2428) 2024-05-21 15:19:21 -05:00
.prettierrc.json refactor: convert to ES Modules and remove traces of CommonJS except in Rollup config because some dependencies are still CommonJS 2023-06-29 19:02:08 -07:00
babel.config.json build: v5 updates and refactors (#2428) 2024-05-21 15:19:21 -05:00
CHANGELOG.md chore: Fix typo in multiple file of docsify (#2284) 2023-10-20 09:24:35 +08:00
CONTRIBUTING.md refactor: delete the experimental and incomplete SSR feature 2023-06-25 12:03:44 -07:00
Dockerfile test:docker locally. 2021-12-10 01:55:30 +08:00
HISTORY.md Ensure code format (#2138) 2023-08-09 17:53:30 +08:00
jest.config.js build: v5 updates and refactors (#2428) 2024-05-21 15:19:21 -05:00
LICENSE Update LICENSE 2022-01-16 19:52:18 -08:00
middleware.js build: v5 updates and refactors (#2428) 2024-05-21 15:19:21 -05:00
package-lock.json chore: Update marked dependency (4 => 12) (#2439) 2024-05-23 22:15:25 -05:00
package.json chore: Update marked dependency (4 => 12) (#2439) 2024-05-23 22:15:25 -05:00
playwright.config.js chore: Update local and Vercel preview. Fix CSS watch functionality. (#2348) 2023-12-22 13:27:13 +08:00
README.md chore: sponsors list fix. (#2175) 2023-08-14 15:02:32 +08:00
rollup.config.js build: v5 updates and refactors (#2428) 2024-05-21 15:19:21 -05:00
SECURITY.md Ensure code format (#2138) 2023-08-09 17:53:30 +08:00
server.configs.js build: v5 updates and refactors (#2428) 2024-05-21 15:19:21 -05:00
server.js chore: Update local and Vercel preview. Fix CSS watch functionality. (#2348) 2023-12-22 13:27:13 +08:00
vercel.json chore: Update local and Vercel preview. Fix CSS watch functionality. (#2348) 2023-12-22 13:27:13 +08:00

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

Docsify turns one or more Markdown files into a Website, with no build process required.

Features

  • No statically built html files
  • Simple and lightweight
  • Smart full-text search plugin
  • Multiple themes
  • Useful plugin API
  • Support embedded files

Quick Start

Get going fast by using a static web server or GitHub Pages with this ready-to-use Docsify Template, review the quick start tutorial or jump right into a CodeSandbox example site with the button below.

Edit 307qqv236

Showcase

A large collection of showcase projects are included in awesome-docsify.

Contributing

See CONTRIBUTING.md.

Backers

Thank you to all our backers! 🙏 [Become a backer]

Sponsors

Thank you for supporting this project❤️ [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