archive-gh-me/docsify
1
0
Fork 0
mirror of https://github.com/docsifyjs/docsify.git synced 2025-12-08 19:55:52 +00:00
Code Issues Projects Releases Wiki Activity
1,914 Commits 28 Branches 197 Tags
Go to file
Clone
Open with VS Code Open with VSCodium Open with Intellij IDEA
Download ZIP Download TAR.GZ Download BUNDLE
dependabot[bot] 44ec7cf83e
chore: bump glob from 11.1.0 to 13.0.0 (#2641)
2025-12-08 10:46:37 +08:00
.github
feat: output type definitions, and allow new Docsify(opts) to accept options for ESM usage (#2392)
2025-12-03 21:49:44 -08:00
.husky
fix: husky can not auto install issue after upgrade. (#2325)
2024-01-17 22:49:35 +08:00
.vscode
feat: output type definitions, and allow new Docsify(opts) to accept options for ESM usage (#2392)
2025-12-03 21:49:44 -08:00
build
[release] 5.0.0-rc.2
2025-09-05 12:19:04 +08:00
docs
feat: output type definitions, and allow new Docsify(opts) to accept options for ESM usage (#2392)
2025-12-03 21:49:44 -08:00
src
delete deprecation warning that was not meant to be added in #2392 (#2646)
2025-12-05 17:02:21 -08:00
test
feat: output type definitions, and allow new Docsify(opts) to accept options for ESM usage (#2392)
2025-12-03 21:49:44 -08:00
.editorconfig
add editorconfig (tells editors which basic text format to use)
2020-05-22 01:29:36 -07:00
.gitattributes
chore: create .gitattributes（#2288）
2023-10-23 04:03:53 +08:00
.gitignore
feat: output type definitions, and allow new Docsify(opts) to accept options for ESM usage (#2392)
2025-12-03 21:49:44 -08:00
.gitpod.yml
Ensure code format (#2138)
2023-08-09 17:53:30 +08:00
.npmignore
feat: v5 style overhaul (#2469)
2024-07-19 15:34:51 +00:00
.prettierignore
feat: output type definitions, and allow new Docsify(opts) to accept options for ESM usage (#2392)
2025-12-03 21:49:44 -08: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
[release] 5.0.0-rc.3
2025-09-05 12:24:11 +08:00
CONTRIBUTING.md
docs: fix broken link to issues in CONTRIBUTING.md (#2625)
2025-11-11 14:31:33 +08:00
Dockerfile
test:docker locally.
2021-12-10 01:55:30 +08:00
eslint.config.js
chore: Update lint configuration (ESLint 9, Prettier 3) (#2438)
2024-05-28 15:27:29 -05:00
HISTORY.md
Ensure code format (#2138)
2023-08-09 17:53:30 +08:00
jest.config.js
feat: v5 style overhaul (#2469)
2024-07-19 15:34:51 +00:00
LICENSE
Update LICENSE
2022-01-16 19:52:18 -08:00
middleware.js
chore: Update lint configuration (ESLint 9, Prettier 3) (#2438)
2024-05-28 15:27:29 -05:00
package-lock.json
chore: bump glob from 11.1.0 to 13.0.0 (#2641)
2025-12-08 10:46:37 +08:00
package.json
chore: bump glob from 11.1.0 to 13.0.0 (#2641)
2025-12-08 10:46:37 +08:00
playwright.config.js
chore: Update local and Vercel preview. Fix CSS watch functionality. (#2348)
2023-12-22 13:27:13 +08:00
postcss.config.cjs
feat: v5 style overhaul (#2469)
2024-07-19 15:34:51 +00:00
README.md
docs: Update intro paragraph to help improve first impressions and broaden audience (#2602)
2025-09-28 10:43:05 +08:00
rollup.config.js
feat: v5 style overhaul (#2469)
2024-07-19 15:34:51 +00:00
SECURITY.md
Ensure code format (#2138)
2023-08-09 17:53:30 +08:00
server.configs.js
feat: v5 style overhaul (#2469)
2024-07-19 15:34:51 +00:00
server.js
chore: Update local and Vercel preview. Fix CSS watch functionality. (#2348)
2023-12-22 13:27:13 +08:00
tsconfig.json
feat: output type definitions, and allow new Docsify(opts) to accept options for ESM usage (#2392)
2025-12-03 21:49:44 -08:00
vercel.json
chore: Update local and Vercel preview. Fix CSS watch functionality. (#2348)
2023-12-22 13:27:13 +08:00

README.md

docsify

A magical documentation site generator.

Backers on Open Collective Sponsors on Open Collective Build & Test npm 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
  • Emoji support

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.

Links

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

Description
🃏 A magical documentation site generator.
Readme MIT 70 MiB
Languages
JavaScript 86.8%
CSS 12.5%
TypeScript 0.3%
Shell 0.2%
HTML 0.2%