docsify

mirror of https://gitee.com/docsifyjs/docsify.git synced 2024-12-01 19:50:32 +08:00

Migrated repository

Go to file

Joe Pea 4a867ad92d fix typo		2024-04-02 00:38:48 -07:00
.github	chore: bump actions/upload-artifact from 3 to 4 (#2350 )	2024-01-08 16:40:06 +08:00
.husky	fix: husky can not auto install issue after upgrade. (#2325 )	2024-01-17 22:49:35 +08:00
.vscode	output type definitions and adjust package.json so that types are picked up in consumer projects	2024-03-27 17:39:39 -07:00
build	deprecate globals and global script data-* attributes, and set up the package for people to start importing `Docsify` and passing in non-global configs	2024-04-01 11:28:16 -07:00
docs	fix typo	2024-04-02 00:38:48 -07:00
src	deprecate globals and global script data-* attributes, and set up the package for people to start importing `Docsify` and passing in non-global configs	2024-04-01 11:28:16 -07:00
test	chore: Update local and Vercel preview. Fix CSS watch functionality. (#2348 )	2023-12-22 13:27:13 +08:00
.editorconfig	add editorconfig (tells editors which basic text format to use)	2020-05-22 01:29:36 -07:00
.eslintignore	add dist to eslintignore	2024-04-02 00:23:45 -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
.gitattributes	chore: create .gitattributes（#2288）	2023-10-23 04:03:53 +08:00
.gitignore	output type definitions and adjust package.json so that types are picked up in consumer projects	2024-03-27 17:39:39 -07:00
.gitpod.yml	Ensure code format (#2138 )	2023-08-09 17:53:30 +08: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
.prettierignore	ignore dist in prettierignore	2024-03-27 17:52:56 -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: Fix typo in multiple file of docsify (#2284 )	2023-10-20 09:24:35 +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	Ensure code format (#2138 )	2023-08-09 17:53:30 +08:00
jest.config.js	chore: Update local and Vercel preview. Fix CSS watch functionality. (#2348 )	2023-12-22 13:27:13 +08:00
LICENSE	Update LICENSE	2022-01-16 19:52:18 -08:00
middleware.js	chore: Update local and Vercel preview. Fix CSS watch functionality. (#2348 )	2023-12-22 13:27:13 +08:00
package-lock.json	chore: bump husky from 8.0.3 to 9.0.11 (#2382 )	2024-03-04 18:41:16 +08:00
package.json	deprecate globals and global script data-* attributes, and set up the package for people to start importing `Docsify` and passing in non-global configs	2024-04-01 11:28:16 -07:00
playwright.config.js	chore: Update local and Vercel preview. Fix CSS watch functionality. (#2348 )	2023-12-22 13:27:13 +08:00
README.md	chore: sponsors list fix. (#2175 )	2023-08-14 15:02:32 +08:00
SECURITY.md	Ensure code format (#2138 )	2023-08-09 17:53:30 +08:00
server.configs.js	chore: Update local and Vercel preview. Fix CSS watch functionality. (#2348 )	2023-12-22 13:27:13 +08:00
server.js	chore: Update local and Vercel preview. Fix CSS watch functionality. (#2348 )	2023-12-22 13:27:13 +08:00
tsconfig.json	deprecate globals and global script data-* attributes, and set up the package for people to start importing `Docsify` and passing in non-global configs	2024-04-01 11:28:16 -07:00
vercel.json	chore: Update local and Vercel preview. Fix CSS watch functionality. (#2348 )	2023-12-22 13:27:13 +08:00

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
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.