From c76aad4c2333971ffb8e79e28c2907a348851e96 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=B0=8F=E5=8D=A1=E5=A1=94=E5=85=8B?= <39011904+Goldloli@users.noreply.github.com> Date: Mon, 2 Nov 2026 13:16:19 +0800 Subject: [PATCH 1/2] docs: fix relative links to themes and configuration pages --- docs/emoji.md | 2 +- docs/language-highlight.md | 4 ++-- docs/write-a-plugin.md | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/emoji.md b/docs/emoji.md index 84a4fd56f3..442ef7e3be 100644 --- a/docs/emoji.md +++ b/docs/emoji.md @@ -1,6 +1,6 @@ # Emoji -Below is a complete list of emoji shorthand codes. Docsify can be configured to render emoji using GitHub-style emoji images or native emoji characters using the [`nativeEmoji`](configuration#nativeemoji) configuration option. +Below is a complete list of emoji shorthand codes. Docsify can be configured to render emoji using GitHub-style emoji images or native emoji characters using the [`nativeEmoji`](configuration.md#nativeemoji) configuration option.
diff --git a/docs/language-highlight.md b/docs/language-highlight.md index f26c779b8d..c8d38f1a06 100644 --- a/docs/language-highlight.md +++ b/docs/language-highlight.md @@ -77,7 +77,7 @@ Support for additional [languages](https://prismjs.com/#supported-languages) is ## Theme support -Docsify's official [themes](themes) are compatible with Prism syntax highlighting themes. +Docsify's official [themes](themes.md) are compatible with Prism syntax highlighting themes. > [!IMPORTANT] Prism themes must be loaded after Docsify themes. @@ -107,7 +107,7 @@ Themes can be applied in light and/or dark mode /> ``` -The following Docsify [theme properties](themes#theme-properties) will override Prism theme styles by default: +The following Docsify [theme properties](themes.md#theme-properties) will override Prism theme styles by default: ```text --border-radius diff --git a/docs/write-a-plugin.md b/docs/write-a-plugin.md index 6e3462c92c..b37ab6e3b7 100644 --- a/docs/write-a-plugin.md +++ b/docs/write-a-plugin.md @@ -192,7 +192,7 @@ hook.ready(() => { - Access Docsify methods and properties using `window.Docsify` - Access the current Docsify instance using the `vm` argument -- Developers who prefer using a debugger can set the [`catchPluginErrors`](configuration#catchpluginerrors) configuration option to `false` to allow their debugger to pause JavaScript execution on error +- Developers who prefer using a debugger can set the [`catchPluginErrors`](configuration.md#catchpluginerrors) configuration option to `false` to allow their debugger to pause JavaScript execution on error - Be sure to test your plugin on all supported platforms and with related configuration options (if applicable) before publishing ## Examples From cdd8df7c616224b0a104464e980197b6efd79e01 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E5=B0=8F=E5=8D=A1=E5=A1=94=E5=85=8B?= <39011904+Goldloli@users.noreply.github.com> Date: Mon, 2 Nov 2026 18:04:14 +0800 Subject: [PATCH 2/2] docs: add missing .md extensions to sibling page links --- docs/adding-pages.md | 4 ++-- docs/configuration.md | 8 ++++---- docs/cover.md | 6 +++--- docs/custom-navbar.md | 4 ++-- docs/themes.md | 2 +- 5 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/adding-pages.md b/docs/adding-pages.md index fde7872d5b..474aaf0446 100644 --- a/docs/adding-pages.md +++ b/docs/adding-pages.md @@ -27,7 +27,7 @@ docs/zh-cn/guide.md => http://domain.com/#/zh-cn/guide In order to have a sidebar, you can create your own `_sidebar.md` (see [this documentation's sidebar](https://github.com/docsifyjs/docsify/blob/main/docs/_sidebar.md) for an example): -First, you need to set `loadSidebar` to **true**. Details are available in the [configuration paragraph](configuration#loadsidebar). +First, you need to set `loadSidebar` to **true**. Details are available in the [configuration paragraph](configuration.md#loadsidebar). ```html @@ -115,7 +115,7 @@ A page's `title` tag is generated from the _selected_ sidebar item name. For bet Once you've created `_sidebar.md`, the sidebar content is automatically generated based on the headers in the markdown files. -A custom sidebar can also automatically generate a table of contents by setting a `subMaxLevel`, compare [subMaxLevel configuration](configuration#submaxlevel). +A custom sidebar can also automatically generate a table of contents by setting a `subMaxLevel`, compare [subMaxLevel configuration](configuration.md#submaxlevel). ```html diff --git a/docs/configuration.md b/docs/configuration.md index 16d1fded40..d493552c38 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -211,7 +211,7 @@ window.$docsify = { - Type: `Boolean` - Default: `null` -Execute the script on the page. Only parses the first script tag ([demo](themes)). If Vue is detected, this is `true` by default. +Execute the script on the page. Only parses the first script tag ([demo](themes.md)). If Vue is detected, this is `true` by default. ```js window.$docsify = { @@ -389,7 +389,7 @@ window.$docsify = { - Type: `Boolean|Object` - Default: `Object` - \\ Toggle the sidebar menu - - / Focus on [search](plugins#full-text-search) field. Also supports alt / ctrl + k. + - / Focus on [search](plugins.md#full-text-search) field. Also supports alt / ctrl + k. Binds key combination(s) to a custom callback function. @@ -1059,7 +1059,7 @@ For more details, see [#1131](https://github.com/docsifyjs/docsify/issues/1131). ## themeColor ⚠️ :id=themecolor -> [!IMPORTANT] Deprecated as of v5. Use the `--theme-color` [theme property](themes#theme-properties) to [customize](themes#customization) your theme color. +> [!IMPORTANT] Deprecated as of v5. Use the `--theme-color` [theme property](themes.md#theme-properties) to [customize](themes.md#customization) your theme color. - Type: `String` @@ -1073,7 +1073,7 @@ window.$docsify = { ## topMargin ⚠️ :id=topmargin -> [!IMPORTANT] Deprecated as of v5. Use the `--scroll-padding-top` [theme property](themes#theme-properties) to specify a scroll margin when using a sticky navbar. +> [!IMPORTANT] Deprecated as of v5. Use the `--scroll-padding-top` [theme property](themes.md#theme-properties) to specify a scroll margin when using a sticky navbar. - Type: `Number|String` - Default: `0` diff --git a/docs/cover.md b/docs/cover.md index a992831fef..44c83ff34d 100644 --- a/docs/cover.md +++ b/docs/cover.md @@ -1,6 +1,6 @@ # Cover -Activate the cover feature by setting `coverpage` to **true**. See [coverpage configuration](configuration#coverpage). +Activate the cover feature by setting `coverpage` to **true**. See [coverpage configuration](configuration.md#coverpage). ## Basic usage @@ -31,7 +31,7 @@ window.$docsify = { ## Customization -The cover page can be customized using [theme properties](themes#theme-properties): +The cover page can be customized using [theme properties](themes.md#theme-properties): ```css @@ -60,7 +60,7 @@ Alternatively, a background color or image can be specified in the cover page ma ## Coverpage as homepage -Normally, the coverpage and the homepage appear at the same time. Of course, you can also separate the coverpage by [`onlyCover`](configuration#onlycover) option. +Normally, the coverpage and the homepage appear at the same time. Of course, you can also separate the coverpage by [`onlyCover`](configuration.md#onlycover) option. ## Multiple covers diff --git a/docs/custom-navbar.md b/docs/custom-navbar.md index 8f2ad880fb..11cdf284db 100644 --- a/docs/custom-navbar.md +++ b/docs/custom-navbar.md @@ -20,7 +20,7 @@ If you need custom navigation, you can create a HTML-based navigation bar. ## Markdown -Alternatively, you can create a custom markdown-based navigation file by setting `loadNavbar` to **true** and creating `_navbar.md`, compare [loadNavbar configuration](configuration#loadnavbar). +Alternatively, you can create a custom markdown-based navigation file by setting `loadNavbar` to **true** and creating `_navbar.md`, compare [loadNavbar configuration](configuration.md#loadnavbar). ```html @@ -84,7 +84,7 @@ renders as ## Combining custom navbars with the emoji plugin -If you use the [emoji plugin](plugins#emoji): +If you use the [emoji plugin](plugins.md#emoji): ```html diff --git a/docs/themes.md b/docs/themes.md index 698ad90551..eb7b543ed1 100644 --- a/docs/themes.md +++ b/docs/themes.md @@ -306,7 +306,7 @@ Docsify provides [theme properties](#theme-properties) for simplified customizat > [!TIP] **Theme authors**: Consider providing instructions for loading your recommended web fonts manually instead of including them in your theme using `@import`. This allows users who prefer a different font to avoid loading your recommended web font(s) unnecessarily. -4. Advanced styling may require custom CSS declarations. This is expected, however custom CSS declarations may break when new versions of Docsify are released. When possible, leverage [theme properties](#theme-properties) instead of custom declarations or lock your [CDN](cdn) URLs to a [specific version](cdn#specific-version) to avoid potential issues when using custom CSS declarations. +4. Advanced styling may require custom CSS declarations. This is expected, however custom CSS declarations may break when new versions of Docsify are released. When possible, leverage [theme properties](#theme-properties) instead of custom declarations or lock your [CDN](cdn.md) URLs to a [specific version](cdn.md#specific-version) to avoid potential issues when using custom CSS declarations. ```css .sidebar li.active > a {