GithubStar/docsify
1
0
Fork 0
mirror of https://github.com/docsifyjs/docsify.git synced 2026-10-17 04:31:18 +08:00
Code Issues Packages Projects Releases Wiki Activity
1,873 Commits 39 Branches 199 Tags
be534674e51e5e47428e1d3be8d8f9987d14313d
T
Clone
Open with VS Code Open with VSCodium Open with Intellij IDEA
Download ZIP Download TAR.GZ Download BUNDLE
Luffy be534674e5 chore: update launch configuration (#2587)
2025-08-04 10:51:58 +08:00
.github
chore: update pull requests and issues template (#2584)
2025-07-30 10:10:37 +08:00
.husky
fix: husky can not auto install issue after upgrade. (#2325)
2024-01-17 22:49:35 +08:00
.vscode
chore: update launch configuration (#2587)
2025-08-04 10:51:58 +08:00
build
[release] 5.0.0-rc.1
2025-05-27 10:36:20 +08:00
docs
refactor: simplify auto header insertion logic (#2578)
2025-08-02 15:15:36 +08:00
src
refactor: simplify auto header insertion logic (#2578)
2025-08-02 15:15:36 +08:00
test
chore: update launch configuration (#2587)
2025-08-04 10:51:58 +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
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
feat: v5 style overhaul (#2469)
2024-07-19 15:34:51 +00:00
.prettierignore
feat: v5 style overhaul (#2469)
2024-07-19 15:34:51 +00: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
fix: remove block display from anchor links to prevent layout issues (#2576)
2025-07-24 11:00:54 +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
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 jest-environment-jsdom from 29.7.0 to 30.0.5 (#2590)
2025-08-02 23:22:39 +08:00
package.json
chore: bump jest-environment-jsdom from 29.7.0 to 30.0.5 (#2590)
2025-08-02 23:22:39 +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
chore: remove sponsors section (#2544)
2025-05-06 17:12:42 +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
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

Reference in New Issue View Git Blame Copy Permalink
S
Description
🃏 A magical documentation site generator.
Readme MIT 77 MiB
Languages
JavaScript 89%
CSS 10.4%
TypeScript 0.2%
Shell 0.2%
HTML 0.2%