docsify

🃏 A magical documentation site generator.

doc docs docsify documentation documentation-tool github-pages markdown vue

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

Luffy 561c777df8 fix: parse heading error (#2526 )		2 weeks ago
.github	ci: Optimize CI processes (#2451 )	8 months ago
.husky	fix: husky can not auto install issue after upgrade. (#2325 )	1 year ago
.vscode	refactor: convert to ES Modules and remove traces of CommonJS except in Rollup config because some dependencies are still CommonJS	2 years ago
build	chore: Update lint configuration (ESLint 9, Prettier 3) (#2438 )	8 months ago
docs	docs: Update Netlify deployment (#1781 )	1 month ago
src	fix: parse heading error (#2526 )	2 weeks ago
test	fix(search): clean markdown elements in search contents (#2457 )	4 months ago
.editorconfig	add editorconfig (tells editors which basic text format to use)	5 years ago
.gitattributes	chore: create .gitattributes（#2288）	1 year ago
.gitignore	build: v5 updates and refactors (#2428 )	8 months ago
.gitpod.yml	Ensure code format (#2138 )	1 year ago
.npmignore	feat: v5 style overhaul (#2469 )	6 months ago
.prettierignore	feat: v5 style overhaul (#2469 )	6 months ago
.prettierrc.json	refactor: convert to ES Modules and remove traces of CommonJS except in Rollup config because some dependencies are still CommonJS	2 years ago
CHANGELOG.md	chore: Fix typo in multiple file of docsify (#2284 )	1 year ago
CONTRIBUTING.md	refactor: delete the experimental and incomplete SSR feature	2 years ago
Dockerfile	test:docker locally.	3 years ago
HISTORY.md	Ensure code format (#2138 )	1 year ago
LICENSE	Update LICENSE	3 years ago
README.md	docs: Add Gold sponsors (#2485 )	6 months ago
SECURITY.md	Ensure code format (#2138 )	1 year ago
babel.config.json	build: v5 updates and refactors (#2428 )	8 months ago
eslint.config.js	chore: Update lint configuration (ESLint 9, Prettier 3) (#2438 )	8 months ago
jest.config.js	feat: v5 style overhaul (#2469 )	6 months ago
middleware.js	chore: Update lint configuration (ESLint 9, Prettier 3) (#2438 )	8 months ago
package-lock.json	chore: bump @rollup/plugin-node-resolve from 15.2.3 to 16.0.0 (#2522 )	3 weeks ago
package.json	chore: bump @rollup/plugin-node-resolve from 15.2.3 to 16.0.0 (#2522 )	3 weeks ago
playwright.config.js	chore: Update local and Vercel preview. Fix CSS watch functionality. (#2348 )	1 year ago
postcss.config.cjs	feat: v5 style overhaul (#2469 )	6 months ago
rollup.config.js	feat: v5 style overhaul (#2469 )	6 months ago
server.configs.js	feat: v5 style overhaul (#2469 )	6 months ago
server.js	chore: Update local and Vercel preview. Fix CSS watch functionality. (#2348 )	1 year ago
vercel.json	chore: Update local and Vercel preview. Fix CSS watch functionality. (#2348 )	1 year ago

README.md

A magical documentation site generator.

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.