From 7eff474d81e215b2c7d0f6f4d455a0af85312e3b Mon Sep 17 00:00:00 2001 From: John Hildenbiddle Date: Sat, 7 Oct 2023 17:18:32 -0500 Subject: [PATCH] Update docs --- docs/configuration.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/docs/configuration.md b/docs/configuration.md index f6748e6c1..bda7b848c 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -811,6 +811,39 @@ window.$docsify = { } ``` +## skipLink + +- Type: `Boolean|String|Object` +- Default: `'Skip to main content'` + +Determines if/how the site's [skip navigation link](https://webaim.org/techniques/skipnav/) will be rendered. + +```js +// Render skip link or all routes (default) +window.$docsify = { + skipLink: 'Skip to main content', +}; +``` + +```js +// Render localized skip links based on route paths +window.$docsify = { + skipLink: { + '/es/': 'Saltar al contenido principal', + '/de-de/': 'Ga naar de hoofdinhoud', + '/ru-ru/': 'Перейти к основному содержанию', + '/zh-cn/': '跳到主要内容', + }, +}; +``` + +```js +// Do not render skip link +window.$docsify = { + skipLink: false, +}; +``` + ## subMaxLevel - Type: `Number`