Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

[Release]: v5.0.0-rc.2 #2598

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
sy-records wants to merge 33 commits into main from develop
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
33 commits
Select commit Hold shift + click to select a range
08372d9
chore: bump rollup-plugin-import-css from 3.5.0 to 4.0.1 (#2554)
dependabot[bot] Jun 2, 2025
3d53203
chore: bump lint-staged from 15.2.7 to 16.1.0 (#2553)
dependabot[bot] Jun 3, 2025
71ac41e
refactor: optimize toggleSidebar trigger conditions (#2557)
sy-records Jun 14, 2025
0e1e0db
chore: bump stefanzweifel/git-auto-commit-action from 5 to 6 (#2562)
dependabot[bot] Jul 2, 2025
96852f0
chore: bump marked from 15.0.3 to 16.0.0 (#2559)
dependabot[bot] Jul 3, 2025
375c058
fix: exclude app-name-link from sidebar text overflow styling (#2564)
sy-records Jul 5, 2025
20d095b
fix: enhance focus handling by adding smooth scroll to content area (...
sy-records Jul 18, 2025
3709947
chore: bump form-data from 4.0.0 to 4.0.4 (#2572)
dependabot[bot] Jul 22, 2025
a2f734f
feat: support config helper multi keys if supported (#2571)
Koooooo-7 Jul 22, 2025
84ba468
chore: remove themes directory from package.json files list (#2574)
sy-records Jul 22, 2025
72569de
fix: handle hash navigation to prevent duplicate callbacks (#2575)
sy-records Jul 24, 2025
6e45024
fix: remove block display from anchor links to prevent layout issues ...
sy-records Jul 24, 2025
be21637
fix: heading link overflow style (#2568)
dajrivera Jul 25, 2025
5a49729
docs: update sidebar link formatting (#2577)
sy-records Jul 28, 2025
3c114d1
chore: bump jest from 29.7.0 to 30.0.3 (#2561)
dependabot[bot] Jul 28, 2025
77420df
chore: update pull requests and issues template (#2584)
sy-records Jul 30, 2025
c9301b0
docs: Improve Quick start instructions (#1466)
waldyrious Jul 30, 2025
b468bcd
refactor: simplify auto header insertion logic (#2578)
sy-records Aug 2, 2025
af05d17
chore: bump cross-env from 7.0.3 to 10.0.0 (#2589)
dependabot[bot] Aug 2, 2025
00d590f
chore: bump jest-environment-jsdom from 29.7.0 to 30.0.5 (#2590)
dependabot[bot] Aug 2, 2025
be53467
chore: update launch configuration (#2587)
sy-records Aug 4, 2025
5448d93
docs: Included relevant CSS vars to theme docs. (#2592)
paulhibbitts Aug 6, 2025
743e9cb
fix: escape HTML in search keywords (#2586)
sy-records Aug 7, 2025
4c9e111
docs: remove loading dialog section from quickstart guide (#2585)
sy-records Aug 7, 2025
5ac5a86
style: force light mode for iframes in dark theme (#2593)
paulhibbitts Aug 7, 2025
32aa74e
feat: support extract content between fragment markers from Markdown ...
sy-records Aug 9, 2025
22ac7e8
fix: enhance focus handling (#2595)
sy-records Aug 21, 2025
2a49bd0
fix(sidebar): remove ignored headings and children (#2580)
sy-records Aug 25, 2025
eeacfcc
fix: update relative link handling (#2579)
sy-records Aug 30, 2025
9bc58c9
fix: improve slug generation (#2581)
sy-records Aug 31, 2025
2e59b0f
feat: GitHub style callouts (#2487)
jhildenbiddle Sep 1, 2025
5999f09
fix: normalize slugs to NFC and remove emoji variation selector (#2597)
sy-records Sep 2, 2025
400ecbc
[release] 5.0.0-rc.2
sy-records Sep 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 0 additions & 54 deletions .github/ISSUE_TEMPLATE/bug_report.md
View file Open in desktop

This file was deleted.

61 changes: 61 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
View file Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
name: Bug Report
description: Submit a bug report.
labels: ['bug', 'Triage']

body:
- type: markdown
attributes:
value: |
Thanks for taking the time to fill out this bug report! **Please write in English**.
Before creating an issue please make sure you are using the latest version of Docsify.

- type: textarea
attributes:
label: Description
description: A clear and concise description of what the bug is, and why you consider it to be a bug.
validations:
required: true

- type: textarea
attributes:
label: Expected behavior
description: A description of what you expected to happen.
validations:
required: true
- type: textarea
attributes:
label: Actual behavior
description: A description of what is actually happening.
validations:
required: true
- type: textarea
attributes:
label: Steps to reproduce
description: |
A description with steps to reproduce the issue.
Provide a link to a public repository or create a reproducible [sandbox](https://codesandbox.io/s/307qqv236):
placeholder: |
1. Step 1
2. Step 2
validations:
required: true

- type: textarea
attributes:
label: Environment
description: |
Please provide the following information if relevant to the issue:
```markdown
- Your OS:
- Node.js version:
- npm/yarn version:
- Browser version:
- Docsify version:
- Docsify plugins (if the bug happens when plugins enabled, please try to isolate the issue):
```

- type: checkboxes
attributes:
label: Additional Information
options:
- label: Bug still occurs when all/other plugins are disabled?
32 changes: 0 additions & 32 deletions .github/ISSUE_TEMPLATE/feature_request.md
View file Open in desktop

This file was deleted.

33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
View file Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Feature Request
description: Propose a new feature or improvement for this project.
labels: ['feature request', 'Triage']

body:
- type: markdown
attributes:
value: |
Thank you for suggesting a feature! Please provide as much detail as possible to help us understand your idea. **Write in English.**

- type: textarea
attributes:
label: Problem or Desire
description: What problem or need will this feature address? Why is it important?
validations:
required: true

- type: textarea
attributes:
label: Proposal
description: What is your proposed solution? How should this feature work?
validations:
required: true

- type: textarea
attributes:
label: Implementation Details
description: If you have any ideas about how this feature could be implemented, please share them here.

- type: textarea
attributes:
label: Additional Context
description: Add any other context, screenshots, or references that might help us understand your request.
42 changes: 12 additions & 30 deletions .github/PULL_REQUEST_TEMPLATE.md
View file Open in desktop
Original file line number Diff line number Diff line change
@@ -1,53 +1,35 @@
<!--
Please write in English.
Please follow the template, all sections are required.
Consider opening a feature request first to get your change idea approved.
-->

## Summary

<!--
Describe what the change does and why it should be merged.
Provide **before/after** screenshots for any UI changes.
-->
<!-- Describe what the change does and why it should be merged. Provide **before/after** screenshots for any UI changes. -->

## Related issue, if any:

<!-- Paste issue's link or number hashtag here. -->

## What kind of change does this PR introduce?

<!--
Copy/paste any of the relevant following options:

Bugfix
Feature
Code style update
Refactor
Docs
Build-related changes
Repo settings
Other
<!-- (Change "[ ]" to "[x]" to check a box.) -->

If you choose Other, describe it.
-->
- [ ] Bugfix
- [ ] Feature
- [ ] Code style update (formatting, renaming)
- [ ] Refactoring (no functional changes, no api changes)
- [ ] Build related changes
- [ ] Documentation content changes
- [ ] Other (please describe):

## For any code change,

<!-- (Change "[ ]" to "[x]" to check a box.) -->

- [ ] Related documentation has been updated, if needed
- [ ] Related tests have been added or updated, if needed

## Does this PR introduce a breaking change?

<!-- (pick one) -->

Yes
No

<!-- If yes, describe the impact and migration path for existing applications. -->

- [ ] Yes
- [ ] No

## Tested in the following browsers:

- [ ] Chrome
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/emoji.yml
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:

- name: Commit
id: auto-commit-action
uses: stefanzweifel/git-auto-commit-action@v5
uses: stefanzweifel/git-auto-commit-action@v6
with:
commit_message: 'chore: Sync emoji data with GitHub emoji API'
branch: sync-emoji
Expand Down
18 changes: 8 additions & 10 deletions .vscode/launch.json
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@
"request": "launch",
"name": "Run unit tests",
"runtimeExecutable": "npm",
"runtimeArgs": ["test"],
"runtimeArgs": ["run", "test:jest"],
"console": "integratedTerminal"
},
{
"type": "node",
"request": "launch",
"name": "Run current test file",
"runtimeExecutable": "npx",
"runtimeArgs": ["jest"],
"runtimeExecutable": "npm",
"runtimeArgs": ["run", "test:jest", "--"],
"args": ["-i", "${relativeFile}", "--testPathIgnorePatterns"],
"console": "integratedTerminal"
},
Expand All @@ -26,9 +26,8 @@
"request": "launch",
"name": "Run selected test name",
"runtimeExecutable": "npm",
"runtimeArgs": ["run-script", "test"],
"runtimeArgs": ["run", "test:jest", "--"],
"args": [
"--",
"-i",
"${relativeFile}",
"-t",
Expand All @@ -41,8 +40,8 @@
"type": "node",
"request": "launch",
"name": "Update current test file snapshot(s)",
"runtimeExecutable": "npx",
"runtimeArgs": ["jest"],
"runtimeExecutable": "npm",
"runtimeArgs": ["run", "test:jest", "--"],
"args": [
"-i",
"${relativeFile}",
Expand All @@ -55,10 +54,9 @@
"type": "node",
"request": "launch",
"name": "Update selected test name snapshot(s)",
"runtimeExecutable": "npx",
"runtimeArgs": ["jest"],
"runtimeExecutable": "npm",
"runtimeArgs": ["run", "test:jest", "--"],
"args": [
"--",
"-i",
"${relativeFile}",
"-t",
Expand Down
43 changes: 35 additions & 8 deletions CHANGELOG.md
View file Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,44 @@
# [5.0.0-rc.1](https://github.com/docsifyjs/docsify/compare/v4.13.1...v5.0.0-rc.1) (2025εΉ΄05月27ζ—₯)
# [5.0.0-rc.2](https://github.com/docsifyjs/docsify/compare/v5.0.0-rc.1...v5.0.0-rc.2) (2025εΉ΄09月05ζ—₯)


### Bug Fixes

* enhance focus handling ([#2595](https://github.com/docsifyjs/docsify/issues/2595)) ([22ac7e8](https://github.com/docsifyjs/docsify/commit/22ac7e855de24b13280e9904930e58af58dbd6a7))
* enhance focus handling by adding smooth scroll to content area ([#2569](https://github.com/docsifyjs/docsify/issues/2569)) ([20d095b](https://github.com/docsifyjs/docsify/commit/20d095b53c827c4d0590dee5fd377ba21560d7fb))
* escape HTML in search keywords ([#2586](https://github.com/docsifyjs/docsify/issues/2586)) ([743e9cb](https://github.com/docsifyjs/docsify/commit/743e9cb484cc70859a582fb74d78ea1f52ef2c2a))
* exclude app-name-link from sidebar text overflow styling ([#2564](https://github.com/docsifyjs/docsify/issues/2564)) ([375c058](https://github.com/docsifyjs/docsify/commit/375c058e3e1b12f3507d97a41b3fd8d6c4e904b0))
* handle hash navigation to prevent duplicate callbacks ([#2575](https://github.com/docsifyjs/docsify/issues/2575)) ([72569de](https://github.com/docsifyjs/docsify/commit/72569dee8db92a01e8de5448e05c32afbd090fb2))
* heading link overflow style ([#2568](https://github.com/docsifyjs/docsify/issues/2568)) ([be21637](https://github.com/docsifyjs/docsify/commit/be2163725ae314de3aa9a56c1216ce8c774cfcc6))
* improve slug generation ([#2581](https://github.com/docsifyjs/docsify/issues/2581)) ([9bc58c9](https://github.com/docsifyjs/docsify/commit/9bc58c9ca24db513a90a06752181954aab0628ca))
* remove block display from anchor links to prevent layout issues ([#2576](https://github.com/docsifyjs/docsify/issues/2576)) ([6e45024](https://github.com/docsifyjs/docsify/commit/6e4502416886b9494cd7b510968c351c7e6fc3cd))
* **sidebar:** remove ignored headings and children ([#2580](https://github.com/docsifyjs/docsify/issues/2580)) ([2a49bd0](https://github.com/docsifyjs/docsify/commit/2a49bd0aa4bb17eeb3d9f363c6f2b01e61e778ac))
* update relative link handling ([#2579](https://github.com/docsifyjs/docsify/issues/2579)) ([eeacfcc](https://github.com/docsifyjs/docsify/commit/eeacfcce2a3df4e4146b5b54275553452b317352))


### Features

* GitHub style callouts ([#2487](https://github.com/docsifyjs/docsify/issues/2487)) ([2e59b0f](https://github.com/docsifyjs/docsify/commit/2e59b0f50cf8123b98e4c97c3053aa6985ae13a2))
* support config helper multi keys if supported ([#2571](https://github.com/docsifyjs/docsify/issues/2571)) ([a2f734f](https://github.com/docsifyjs/docsify/commit/a2f734f223cae475aefe7d41995a2030a1f9c0a2))
* support extract content between fragment markers from Markdown ([#2582](https://github.com/docsifyjs/docsify/issues/2582)) ([32aa74e](https://github.com/docsifyjs/docsify/commit/32aa74e0d2fcd89705e5c30fc8b8e2562e7b774e))



# Changelog

## [5.0.0-rc.1](https://github.com/docsifyjs/docsify/compare/v4.13.1...v5.0.0-rc.1) (2025εΉ΄05月27ζ—₯)


### Bug Fixes

* auto header config heading generate func ([#2474](https://github.com/docsifyjs/docsify/issues/2474)) ([4bc5062](https://github.com/docsifyjs/docsify/commit/4bc5062fc13a3a43c7ed432f1b585fdab41f1447))
* carbon broken ([#2387](https://github.com/docsifyjs/docsify/issues/2387)) ([87fd55d](https://github.com/docsifyjs/docsify/commit/87fd55d7125539b929f3260fca92e666e988b6da))
* **ci:** run test action for pull requsts ([#2445](https://github.com/docsifyjs/docsify/issues/2445)) ([15ed3b7](https://github.com/docsifyjs/docsify/commit/15ed3b76b00eac06cc4230b1f592993adf2a893b))
* correct loadSider=false render structure issue ([#2470](https://github.com/docsifyjs/docsify/issues/2470)) ([7cbd532](https://github.com/docsifyjs/docsify/commit/7cbd5322d056bb87b4340bdb19909a9c32d19abb))
* **ci:** run test action for pull requests ([#2445](https://github.com/docsifyjs/docsify/issues/2445)) ([15ed3b7](https://github.com/docsifyjs/docsify/commit/15ed3b76b00eac06cc4230b1f592993adf2a893b))
* correct loadSidebar=false render structure issue ([#2470](https://github.com/docsifyjs/docsify/issues/2470)) ([7cbd532](https://github.com/docsifyjs/docsify/commit/7cbd5322d056bb87b4340bdb19909a9c32d19abb))
* dev mode hot reload and add sourcemaps ([#2402](https://github.com/docsifyjs/docsify/issues/2402)) ([947d8de](https://github.com/docsifyjs/docsify/commit/947d8decb8c5c62f3ce50d0c6ac0e27bb6c7a6b5))
* enhancement of isExternal ([#2093](https://github.com/docsifyjs/docsify/issues/2093)) ([7f13ba0](https://github.com/docsifyjs/docsify/commit/7f13ba0f9841776008d0707f027bd80c4e3cbf0c))
* fix cross-origin links in history router mode ([#1967](https://github.com/docsifyjs/docsify/issues/1967)) ([ef6905b](https://github.com/docsifyjs/docsify/commit/ef6905b53a5c1587c3ebf870f0d11ff111a2350d))
* fix dependabot.yml ([a321e83](https://github.com/docsifyjs/docsify/commit/a321e8373b3c6afc9d0b08714e34bd8bd68716d9))
* fix docisify-render denpendency. ([#1915](https://github.com/docsifyjs/docsify/issues/1915)) ([c73f858](https://github.com/docsifyjs/docsify/commit/c73f8587b2f67e28c228e521518110ff504cefeb))
* fix docsify-server-renderer dependency. ([#1915](https://github.com/docsifyjs/docsify/issues/1915)) ([c73f858](https://github.com/docsifyjs/docsify/commit/c73f8587b2f67e28c228e521518110ff504cefeb))
* fix id with pure number. ([#2021](https://github.com/docsifyjs/docsify/issues/2021)) ([f4f21a3](https://github.com/docsifyjs/docsify/commit/f4f21a3f74d265f16b1e658feda417bf851458da))
* genIndex error for search ([#1933](https://github.com/docsifyjs/docsify/issues/1933)) ([a8f9fc1](https://github.com/docsifyjs/docsify/commit/a8f9fc1d5f5c7808efe65e5ca9359f38014b1bcd))
* husky can not auto install issue after upgrade. ([#2325](https://github.com/docsifyjs/docsify/issues/2325)) ([cec43d7](https://github.com/docsifyjs/docsify/commit/cec43d71774556d38fa9746f4df4319a6ad768c2))
Expand Down Expand Up @@ -86,8 +113,8 @@
* Add escapeHtml for search ([#1551](https://github.com/docsifyjs/docsify/issues/1551)) ([c24f7f6](https://github.com/docsifyjs/docsify/commit/c24f7f6f0b87a87f6dd3755f69eb0969ebb029c9))
* allow also " inside of an embed ([ec16e4a](https://github.com/docsifyjs/docsify/commit/ec16e4a9d5718ac4f4c25bb3dcaea3b7551372e0))
* buble theme missing generic fallback font ([#1568](https://github.com/docsifyjs/docsify/issues/1568)) ([37d9f0e](https://github.com/docsifyjs/docsify/commit/37d9f0e1214276e93b2a11ed87390aafa1bdbcec))
* Cannot read property 'classList' of null ([#1527](https://github.com/docsifyjs/docsify/issues/1527)) ([d6df2b8](https://github.com/docsifyjs/docsify/commit/d6df2b85a99371bb9a87402a10dd515bb734182e)), closes [/github.com/docsifyjs/docsify/pull/1527#issuecomment-793455105](https://github.com//github.com/docsifyjs/docsify/pull/1527/issues/issuecomment-793455105)
* Cannot read property 'tagName' of null ([#1655](https://github.com/docsifyjs/docsify/issues/1655)) ([c3cdadc](https://github.com/docsifyjs/docsify/commit/c3cdadc37137edcd9e219359973902d2fc8b66ff)), closes [#1154](https://github.com/docsifyjs/docsify/issues/1154) [/github.com/docsifyjs/docsify/blob/develop/src/core/router/history/html5.js#L25-L27](https://github.com//github.com/docsifyjs/docsify/blob/develop/src/core/router/history/html5.js/issues/L25-L27) [/github.com/docsifyjs/docsify/blob/develop/src/core/router/history/hash.js#L47-L49](https://github.com//github.com/docsifyjs/docsify/blob/develop/src/core/router/history/hash.js/issues/L47-L49)
* Cannot read property 'classList' of null ([#1527](https://github.com/docsifyjs/docsify/issues/1527)) ([d6df2b8](https://github.com/docsifyjs/docsify/commit/d6df2b85a99371bb9a87402a10dd515bb734182e))
* Cannot read property 'tagName' of null ([#1655](https://github.com/docsifyjs/docsify/issues/1655)) ([c3cdadc](https://github.com/docsifyjs/docsify/commit/c3cdadc37137edcd9e219359973902d2fc8b66ff))
* upgrade debug from 4.3.2 to 4.3.3 ([#1692](https://github.com/docsifyjs/docsify/issues/1692)) ([40e7749](https://github.com/docsifyjs/docsify/commit/40e77490c68b4143c75dfaebcd0b7f640581306b))
* Upgrade docsify from 4.12.0 to 4.12.1 ([#1544](https://github.com/docsifyjs/docsify/issues/1544)) ([d607f6d](https://github.com/docsifyjs/docsify/commit/d607f6d71c35b50f586806a832f65061f5e3427e))
* upgrade dompurify from 2.2.6 to 2.2.7 ([#1552](https://github.com/docsifyjs/docsify/issues/1552)) ([407e4d4](https://github.com/docsifyjs/docsify/commit/407e4d4f3de78bebd639a3fdae751f8045728e57))
Expand Down Expand Up @@ -937,7 +964,7 @@ Fix the last release files has the old version marked...

### Bug Fixes

- get file path, fixed jrappen/sublime-distractionless/commit/81bfadd391428823191cc03eca956a2312e04d13#commitcomment-22427070 ([e8117e5](https://github.com/QingWei-Li/docsify/commit/e8117e5)), closes [jrappen/sublime-distractionless/commit/81bfadd391428823191cc03eca956a2312e04d13#commitcomment-22427070](https://github.com/jrappen/sublime-distractionless/commit/81bfadd391428823191cc03eca956a2312e04d13/issues/commitcomment-22427070)
- get file path([e8117e5](https://github.com/QingWei-Li/docsify/commit/e8117e5))

### Features

Expand Down Expand Up @@ -1086,5 +1113,5 @@ Fix the last release files has the old version marked...
### Features

- finish ssr ([3444884](https://github.com/QingWei-Li/docsify/commit/3444884))
- init ocsify-server-renderer ([6dea685](https://github.com/QingWei-Li/docsify/commit/6dea685))
- init docsify-server-renderer ([6dea685](https://github.com/QingWei-Li/docsify/commit/6dea685))
- support history mode ([f095eb8](https://github.com/QingWei-Li/docsify/commit/f095eb8))
1 change: 0 additions & 1 deletion build/emoji.js
View file Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,6 @@ function writeEmojiJS(emojiData) {
const isExistingPage = fs.existsSync(filePaths.emojiJS);
const emojiJS = isExistingPage && fs.readFileSync(filePaths.emojiJS, 'utf8');
const newEmojiJS = [
'/* eslint-disable */\n',
'// =============================================================================',
'// DO NOT EDIT: This file is auto-generated by an /build/emoji.js',
'// =============================================================================\n',
Expand Down
Loading
Loading

AltStyle γ«γ‚ˆγ£γ¦ε€‰ζ›γ•γ‚ŒγŸγƒšγƒΌγ‚Έ (->γ‚ͺγƒͺγ‚ΈγƒŠγƒ«) /