Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions docs/adding-pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<!-- index.html -->
Expand Down Expand Up @@ -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
<!-- index.html -->
Expand Down
8 changes: 4 additions & 4 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {
Expand Down Expand Up @@ -389,7 +389,7 @@ window.$docsify = {
- Type: `Boolean|Object`
- Default: `Object`
- <kbd>\\</kbd> Toggle the sidebar menu
- <kbd>/</kbd> Focus on [search](plugins#full-text-search) field. Also supports <kbd>alt</kbd>&nbsp;/&nbsp;<kbd>ctrl</kbd>&nbsp;+&nbsp;<kbd>k</kbd>.
- <kbd>/</kbd> Focus on [search](plugins.md#full-text-search) field. Also supports <kbd>alt</kbd>&nbsp;/&nbsp;<kbd>ctrl</kbd>&nbsp;+&nbsp;<kbd>k</kbd>.

Binds key combination(s) to a custom callback function.

Expand Down Expand Up @@ -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`

Expand All @@ -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`
Expand Down
6 changes: 3 additions & 3 deletions docs/cover.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down Expand Up @@ -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):

<!-- prettier-ignore -->
```css
Expand Down Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions docs/custom-navbar.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<!-- index.html -->
Expand Down Expand Up @@ -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
<!-- index.html -->
Expand Down
2 changes: 1 addition & 1 deletion docs/emoji.md
Original file line number Diff line number Diff line change
@@ -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.

<div style="display: grid; grid-template-columns: repeat(auto-fill, minmax(15em, 1fr));">

Expand Down
4 changes: 2 additions & 2 deletions docs/language-highlight.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/themes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
2 changes: 1 addition & 1 deletion docs/write-a-plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading