docsify

mirror of https://gitee.com/docsifyjs/docsify.git synced 2024-11-29 18:48:14 +08:00

Migrated repository

Go to file

Joe Pea 4e01f4d43c Merge pull request #1970 from docsifyjs/update-routerMode-docs docs: add notes on "hash" vs "history" routing in the config docs		2023-07-16 10:23:05 -07:00
.github	build: run tests for all pushes, so we can see build status in any pull request and not only for those to main or develop	2023-06-29 19:02:28 -07: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	Merge branch 'es-modules' into update-rollup	2023-07-02 12:48:13 -07:00
docs	Merge branch 'develop' into update-routerMode-docs	2023-07-16 10:18:21 -07:00
src	Merge branch 'develop' into es-modules	2023-07-02 12:17:19 -07:00
test	Merge branch 'develop' into es-modules	2023-07-02 12:17:19 -07:00
.editorconfig	add editorconfig (tells editors which basic text format to use)	2020-05-22 01:29:36 -07:00
.eslintignore	refactor: delete the experimental and incomplete SSR feature	2023-06-25 12:03:44 -07: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
.gitignore	fix: Coverpage when content > viewport height (#1744 )	2022-02-03 16:03:34 -06:00
.gitpod.yml	[gitpod-setup] fix the preview opening issue.	2020-03-14 07:31:11 +00: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
.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	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
CHANGELOG.md	chore: add changelog v4.13.0	2022-10-26 21:50:32 +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	Fix typos (#326 )	2017-12-16 12:06:12 +08:00
index.html	docs: Fix missing dolphin theme (#1960 )	2023-01-10 16:02:02 +08:00
jest.config.js	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
LICENSE	Update LICENSE	2022-01-16 19:52:18 -08:00
package-lock.json	Merge branch 'es-modules' into update-rollup	2023-07-02 12:48:13 -07:00
package.json	Merge branch 'es-modules' into update-rollup	2023-07-02 12:48:13 -07:00
playwright.config.js	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
README.md	Merge branch 'develop' into es-modules	2023-07-16 09:57:30 -07:00
SECURITY.md	Create SECURITY.md (#1634 )	2021-09-10 13:57:38 +08:00
server.js	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

README.md

A magical documentation site generator.

Gold Sponsor via Open Collective

Features

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

Quick start

Look at this tutorial

Showcase

These projects are using docsify to generate their sites. Pull requests welcome 😊

Move to awesome-docsify

Similar projects

Project	Description
Docusaurus	Docusaurus makes it easy to maintain Open Source documentation websites
GitBook	Where technical teams document
MkDocs	Project documentation with Markdown
VuePress	Vue-powered Static Site Generator