docsify

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

Migrated repository

Go to file

Anix ae64b257a1 Some checks are pending Build & Test / lint (lts/) (push) Waiting to run Details Build & Test / test-jest (lts/, macos-latest) (push) Waiting to run Details Build & Test / test-jest (lts/, ubuntu-latest) (push) Waiting to run Details Build & Test / test-jest (lts/, windows-latest) (push) Waiting to run Details Build & Test / test-playwright (lts/*) (push) Waiting to run Details chore: upgrade dexie from 4.0.8 to 4.0.9 (#2515 ) Snyk has created this PR to upgrade dexie from 4.0.8 to 4.0.9. See this package in npm: dexie See this project in Snyk: https://app.snyk.io/org/anikethsaha/project/836f877b-b98e-47ed-89fc-554e9b2e146d?utm_source=github&utm_medium=referral&page=upgrade-pr Co-authored-by: snyk-bot <snyk-bot@snyk.io>		2024-11-19 17:04:56 +08:00
.github	ci: Optimize CI processes (#2451 )	2024-06-11 07:34:48 +08:00
.husky	fix: husky can not auto install issue after upgrade. (#2325 )	2024-01-17 22:49:35 +08: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	chore: Update lint configuration (ESLint 9, Prettier 3) (#2438 )	2024-05-28 15:27:29 -05:00
docs	docs: adds deployment to Kinsta Static Site Hosting (#2299 )	2024-09-21 19:54:31 +08:00
src	fix(search): clean markdown elements in search contents (#2457 )	2024-09-21 19:45:05 +08:00
test	fix(search): clean markdown elements in search contents (#2457 )	2024-09-21 19:45:05 +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	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
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: upgrade dexie from 4.0.8 to 4.0.9 (#2515 )	2024-11-19 17:04:56 +08:00
package.json	chore: upgrade dexie from 4.0.8 to 4.0.9 (#2515 )	2024-11-19 17:04:56 +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: Add Gold sponsors (#2485 )	2024-08-08 13:47:37 +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

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.