docsify

mirror of https://github.com/docsifyjs/docsify.git synced 2026-10-17 04:31:18 +08:00

T

Joe Pea 7e29ca092f chore: Build and publish v4 lib/ and themes/ folders for backwards compatibility while users transition to v5. (#2667 )

* Build and publish v4 lib/ and themes/ folders for backwards compatibility while users transition to v5.

- add a script to build the legacy v4 lib/ and themes/ folders
- append deprecation console warnings to the v4 JS files during the v4 build
- add a script to clean v4 build outputs
- hook the v4 build/clean scripts into the release.sh script
- test the v4 build and clean in CI

* fix: update repository field format in package.json

---------

Co-authored-by: Luffy <52o@qq52o.cn>

2026-02-05 15:38:39 +08:00

.github

chore: Build and publish v4 lib/ and themes/ folders for backwards compatibility while users transition to v5. (#2667 )

2026-02-05 15:38:39 +08:00

.husky

fix: husky can not auto install issue after upgrade. (#2325 )

2024-01-17 22:49:35 +08:00

.vscode

feat: output type definitions, and allow new Docsify(opts) to accept options for ESM usage (#2392 )

2025-12-03 21:49:44 -08:00

build

chore: Build and publish v4 lib/ and themes/ folders for backwards compatibility while users transition to v5. (#2667 )

2026-02-05 15:38:39 +08:00

docs

chore: Build and publish v4 lib/ and themes/ folders for backwards compatibility while users transition to v5. (#2667 )

2026-02-05 15:38:39 +08:00

src

chore: bump marked from 16.0.0 to 17.0.1 (#2647 )

2025-12-17 18:59:25 +08:00

test

docs: Add v5 upgrade docs (#2665 )

2026-01-15 10:23:56 +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

chore: Build and publish v4 lib/ and themes/ folders for backwards compatibility while users transition to v5. (#2667 )

2026-02-05 15:38:39 +08: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: output type definitions, and allow new Docsify(opts) to accept options for ESM usage (#2392 )

2025-12-03 21:49:44 -08: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

[release] 5.0.0-rc.3

2025-09-05 12:24:11 +08:00

CONTRIBUTING.md

docs: fix broken link to issues in CONTRIBUTING.md (#2625 )

2025-11-11 14:31:33 +08: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 globals from 16.0.0 to 17.1.0 (#2657 )

2026-01-24 12:16:41 +08:00

package.json

chore: Build and publish v4 lib/ and themes/ folders for backwards compatibility while users transition to v5. (#2667 )

2026-02-05 15:38: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

docs: Update intro paragraph to help improve first impressions and broaden audience (#2602 )

2025-09-28 10:43:05 +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

tsconfig.json

feat: output type definitions, and allow new Docsify(opts) to accept options for ESM usage (#2392 )

2025-12-03 21:49:44 -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.