🃏 A magical documentation site generator.
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
Go to file
Koy Zhuang cec43d7177
fix: husky can not auto install issue after upgrade. (#2325)
1 month ago
.github chore: bump actions/upload-artifact from 3 to 4 (#2350) 2 months ago
.husky fix: husky can not auto install issue after upgrade. (#2325) 1 month ago
.vscode refactor: convert to ES Modules and remove traces of CommonJS except in Rollup config because some dependencies are still CommonJS 8 months ago
build chore: Update local and Vercel preview. Fix CSS watch functionality. (#2348) 2 months ago
docs docs: Update logo doc (#2347) 2 months ago
src update: render Vue templates by default when import vue resources. (#2327) 2 months ago
test chore: Update local and Vercel preview. Fix CSS watch functionality. (#2348) 2 months ago
.editorconfig add editorconfig (tells editors which basic text format to use) 4 years ago
.eslintignore refactor: delete the experimental and incomplete SSR feature 8 months ago
.eslintrc.cjs refactor: convert to ES Modules and remove traces of CommonJS except in Rollup config because some dependencies are still CommonJS 8 months ago
.gitattributes chore: create .gitattributes(#2288) 4 months ago
.gitignore fix: husky can not auto install issue after upgrade. (#2325) 1 month ago
.gitpod.yml Ensure code format (#2138) 7 months ago
.npmignore refactor: convert to ES Modules and remove traces of CommonJS except in Rollup config because some dependencies are still CommonJS 8 months ago
.prettierignore Ensure code format (#2138) 7 months ago
.prettierrc.json refactor: convert to ES Modules and remove traces of CommonJS except in Rollup config because some dependencies are still CommonJS 8 months ago
CHANGELOG.md chore: Fix typo in multiple file of docsify (#2284) 4 months ago
CONTRIBUTING.md refactor: delete the experimental and incomplete SSR feature 8 months ago
Dockerfile test:docker locally. 2 years ago
HISTORY.md Ensure code format (#2138) 7 months ago
LICENSE Update LICENSE 2 years ago
README.md chore: sponsors list fix. (#2175) 7 months ago
SECURITY.md Ensure code format (#2138) 7 months ago
babel.config.json refactor: convert to ES Modules and remove traces of CommonJS except in Rollup config because some dependencies are still CommonJS 8 months ago
jest.config.js chore: Update local and Vercel preview. Fix CSS watch functionality. (#2348) 2 months ago
middleware.js chore: Update local and Vercel preview. Fix CSS watch functionality. (#2348) 2 months ago
package-lock.json chore: bump follow-redirects from 1.15.3 to 1.15.4 (#2358) 2 months ago
package.json fix: husky can not auto install issue after upgrade. (#2325) 1 month ago
playwright.config.js chore: Update local and Vercel preview. Fix CSS watch functionality. (#2348) 2 months ago
server.configs.js chore: Update local and Vercel preview. Fix CSS watch functionality. (#2348) 2 months ago
server.js chore: Update local and Vercel preview. Fix CSS watch functionality. (#2348) 2 months ago
vercel.json chore: Update local and Vercel preview. Fix CSS watch functionality. (#2348) 2 months ago

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

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