diff --git a/.eslintignore b/.eslintignore new file mode 100644 index 000000000..2d2ecd68d --- /dev/null +++ b/.eslintignore @@ -0,0 +1 @@ +.git/ diff --git a/.eslintrc b/.eslintrc index d6a85f8e0..5620c1cd1 100644 --- a/.eslintrc +++ b/.eslintrc @@ -1,5 +1,7 @@ { - "extends": ["vue"], + "extends": [ + "vue" + ], "env": { "browser": true }, diff --git a/.gitignore b/.gitignore index ee8a51973..c2ba75d2e 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,4 @@ -.DS_Store *.log +.DS_Store +/themes node_modules -/themes \ No newline at end of file diff --git a/.npmignore b/.npmignore new file mode 100644 index 000000000..41b1431c0 --- /dev/null +++ b/.npmignore @@ -0,0 +1,5 @@ +.eslintignore +.eslintrc +.github/ +.gitignore +.travis.yml diff --git a/.travis.yml b/.travis.yml index fb0b83edb..db361c422 100644 --- a/.travis.yml +++ b/.travis.yml @@ -1,6 +1,9 @@ sudo: false cache: directories: - - $HOME/.yarn-cache + - $HOME/.yarn-cache language: node_js node_js: stable +os: + - linux + - osx diff --git a/CHANGELOG.md b/CHANGELOG.md index 3f9fd97cd..f21936c9c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,10 @@ +# 3.5.0 / 2017-03-25 + + * feat(route): auto remove .md extension + * fix: adjust display on small screens [@jrappen](https://github.com/jrappen) + * fix: navbar labels for German [@jrappen](https://github.com/jrappen) + # 3.4.4 / 2017-03-17 * fix(search): fix input style diff --git a/dev.html b/dev.html index 4b31b4d0b..2e88bb421 100644 --- a/dev.html +++ b/dev.html @@ -23,15 +23,14 @@ '/zh-cn/changelog': '/changelog', '/changelog': 'https://raw.githubusercontent.com/QingWei-Li/docsify/master/CHANGELOG' }, + auto2top: true, + basePath: '/docs/', + executeScript: true, loadNavbar: true, - executeScript: true + loadSidebar: true, + name: 'docsify', + subMaxLevel: 2 } - + diff --git a/docs/README.md b/docs/README.md index 1873d46c1..a0b15b5fc 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,9 +4,9 @@ ## What is it -docsify generates your documentation website on the fly. Unlike GitBook, it does not generate static html files. Instead, it smartly loads and parses your Markdown files and displays them as website. All you need to do is create an `index.html` to start and [deploy it on GitHub Pages](/deploy). +docsify generates your documentation website on the fly. Unlike GitBook, it does not generate static html files. Instead, it smartly loads and parses your Markdown files and displays them as website. All you need to do is create an `index.html` to start and [deploy it on GitHub Pages](deploy.md). -See the [Quick start](/quickstart) for more details. +See the [Quick start](quickstart.md) for more details. ## Features diff --git a/docs/_navbar.md b/docs/_navbar.md index 0957c699e..350c32be6 100644 --- a/docs/_navbar.md +++ b/docs/_navbar.md @@ -1,4 +1,4 @@ - :uk: - [:cn: 中文](/zh-cn/) - - [:de: German](/de-de/) + - [:de: Deutsch](/de-de/) - [:uk: English](/) diff --git a/docs/_sidebar.md b/docs/_sidebar.md index c41ac66ae..60374a5e9 100644 --- a/docs/_sidebar.md +++ b/docs/_sidebar.md @@ -1,22 +1,22 @@ - Getting started - - [Quick start](/quickstart) - - [Writing more pages](/more-pages) - - [Custom navbar](/custom-navbar) - - [Cover page](/cover) + - [Quick start](quickstart.md) + - [Writing more pages](more-pages.md) + - [Custom navbar](custom-navbar.md) + - [Cover page](cover.md) - Customization - - [Configuration](/configuration) - - [Themes](/themes) - - [List of Plugins](/plugins) - - [Write a Plugin](/write-a-plugin) - - [Markdown configuration](/markdown) - - [Language highlighting](/language-highlight) + - [Configuration](configuration.md) + - [Themes](themes.md) + - [List of Plugins](plugins.md) + - [Write a Plugin](write-a-plugin.md) + - [Markdown configuration](markdown.md) + - [Language highlighting](language-highlight.md) - Guide - - [Deploy](/deploy) - - [Helpers](/helpers) - - [Vue compatibility](/vue) - - [CDN](/cdn) - - [Offline Mode(PWA)](/pwa) + - [Deploy](deploy.md) + - [Helpers](helpers.md) + - [Vue compatibility](vue.md) + - [CDN](cdn.md) + - [Offline Mode(PWA)](pwa.md) -- [Changelog](/changelog) +- [Changelog](changelog.md) diff --git a/docs/configuration.md b/docs/configuration.md index 8aa1c41e9..574aa0b65 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -166,7 +166,7 @@ window.$docsify = { - Type: `Boolean|String` - Default: `false` -Activate the [cover feature](/cover). If true, it will load from `_coverpage.md`. +Activate the [cover feature](cover.md). If true, it will load from `_coverpage.md`. ```js window.$docsify = { @@ -212,7 +212,7 @@ window.$docsify = { - Type: `Function` -See [Markdown configuration](/markdown). +See [Markdown configuration](markdown.md). ```js window.$docsify = { @@ -294,7 +294,7 @@ window.$docsify = { ``` -Note that if you are running an external script, e.g. an embedded jsfiddle demo, make sure to include the [external-script](plugins?id=external-script) plugin. +Note that if you are running an external script, e.g. an embedded jsfiddle demo, make sure to include the [external-script](plugins.md?id=external-script) plugin. ## no-emoji diff --git a/docs/cover.md b/docs/cover.md index 4d7a4eaf9..8f62007e7 100644 --- a/docs/cover.md +++ b/docs/cover.md @@ -1,6 +1,6 @@ # Cover -Activate the cover feature by setting `coverpage` to **true**, compare [coverpage configuration](configuration#coverpage). +Activate the cover feature by setting `coverpage` to **true**, compare [coverpage configuration](configuration.md#coverpage). ## Basic usage diff --git a/docs/custom-navbar.md b/docs/custom-navbar.md index 5c436bea9..1642918c2 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 [load-navbar configuration](configuration#load-navbar). +Alternatively, you can create a custom markdown-based navigation file by setting `loadNavbar` to **true** and creating `_navbar.md`, compare [load-navbar configuration](configuration.md#load-navbar). ```html @@ -52,17 +52,17 @@ You can create sub-lists by indenting items that are under a certain parent. - Getting started - - [Quick start](/quickstart) - - [Writing more pages](/more-pages) - - [Custom navbar](/custom-navbar) - - [Cover page](/cover) + - [Quick start](quickstart.md) + - [Writing more pages](more-pages.md) + - [Custom navbar](custom-navbar.md) + - [Cover page](cover.md) - Configuration - - [Configuration](/configuration) - - [Themes](/themes) - - [Using plugins](/plugins) - - [Markdown configuration](/markdown) - - [Language highlight](/language-highlight) + - [Configuration](configuration.md) + - [Themes](themes.md) + - [Using plugins](plugins.md) + - [Markdown configuration](markdown.md) + - [Language highlight](language-highlight.md) ``` renders as diff --git a/docs/de-de/README.md b/docs/de-de/README.md index 303ac79a0..9dfc6a25a 100644 --- a/docs/de-de/README.md +++ b/docs/de-de/README.md @@ -4,9 +4,9 @@ ## Was ist das -**docsify** generiert deine Dokumentationswebseite zeitgleich (mit der Darstellung). Im Gegensatz zu GitBook, werden keine statischen HTML Seiten generiert. Stattdessen, werden im Hintergrund Markdown Dateien geladen und umgewandelt, und als Webseite dargestellt. Alles, was du brauchst, ist eine Datei namens `index.html`, um sie über [GitHub Pages zu veröffentlichen](/de-de/deploy). +**docsify** generiert deine Dokumentationswebseite zeitgleich (mit der Darstellung). Im Gegensatz zu GitBook, werden keine statischen HTML Seiten generiert. Stattdessen, werden im Hintergrund Markdown Dateien geladen und umgewandelt, und als Webseite dargestellt. Alles, was du brauchst, ist eine Datei namens `index.html`, um sie über [GitHub Pages zu veröffentlichen](de-de/deploy.md). -Siehe [Schnellstart](/de-de/quickstart) für weitere Informationen. +Siehe [Schnellstart](de-de/quickstart.md) für weitere Informationen. ## Features diff --git a/docs/de-de/_navbar.md b/docs/de-de/_navbar.md index 95260cda8..758167df1 100644 --- a/docs/de-de/_navbar.md +++ b/docs/de-de/_navbar.md @@ -1,4 +1,4 @@ - :de: - [:cn: 中文](/zh-cn/) - - [:de: German](/de-de/) + - [:de: Deutsch](/de-de/) - [:uk: English](/) diff --git a/docs/de-de/_sidebar.md b/docs/de-de/_sidebar.md index a864b3b24..dac8531ca 100644 --- a/docs/de-de/_sidebar.md +++ b/docs/de-de/_sidebar.md @@ -1,22 +1,22 @@ - Loslegen - - [Schnellstart](/de-de/quickstart) - - [Schreiben weiterer Seiten](/de-de/more-pages) - - [Navigationsleiste anpassen](/de-de/custom-navbar) - - [Titelseite](/de-de/cover) + - [Schnellstart](de-de/quickstart.md) + - [Schreiben weiterer Seiten](de-de/more-pages.md) + - [Navigationsleiste anpassen](de-de/custom-navbar.md) + - [Titelseite](de-de/cover.md) - Anpassen - - [Einstellungen](/de-de/configuration) - - [Themen](/de-de/themes) - - [Liste der Erweiterungen](/de-de/plugins) - - [Schreiben eigener Erweiterungen](/de-de/write-a-plugin) - - [Markdown-Einstellungen](/de-de/markdown) - - [Hervorheben von Sprachen](/de-de/language-highlight) + - [Einstellungen](de-de/configuration.md) + - [Themen](de-de/themes.md) + - [Liste der Erweiterungen](de-de/plugins.md) + - [Schreiben eigener Erweiterungen](de-de/write-a-plugin.md) + - [Markdown-Einstellungen](de-de/markdown.md) + - [Hervorheben von Sprachen](de-de/language-highlight.md) - Guide - - [Inbetriebnahme](/de-de/deploy) - - [Helfer](/de-de/helpers) - - [Vue Kompatibilität](/de-de/vue) - - [CDN](/de-de/cdn) - - [Offline Modus (PWA)](/de-de/pwa) + - [Inbetriebnahme](de-de/deploy.md) + - [Helfer](de-de/helpers.md) + - [Vue Kompatibilität](de-de/vue.md) + - [CDN](de-de/cdn.md) + - [Offline Modus (PWA)](de-de/pwa.md) -- [Changelog](/de-de/changelog) +- [Changelog](de-de/changelog.md) diff --git a/docs/de-de/configuration.md b/docs/de-de/configuration.md index 8e5f68222..8fd01ab00 100644 --- a/docs/de-de/configuration.md +++ b/docs/de-de/configuration.md @@ -166,7 +166,7 @@ window.$docsify = { - Typ: `Boolean|String` - Standard: `false` -Aktiviere das [Titelseitenfeature](/de-de/cover). Falls `true`, wird sie von `_coverpage.md` geladen. +Aktiviere das [Titelseitenfeature](de-de/cover.md). Falls `true`, wird sie von `_coverpage.md` geladen. ```js window.$docsify = { @@ -212,7 +212,7 @@ window.$docsify = { - Typ: `Function` -Siehe [Markdown Konfiguration](/de-de/markdown). +Siehe [Markdown Konfiguration](de-de/markdown.md). ```js window.$docsify = { @@ -278,7 +278,7 @@ window.$docsify = { - Typ: `Boolean` -Führe das Skript auf der Seite aus. Analysiere nur das erste script tag ([demo](/de-de/themes)). Sollte Vue verwendet sein, wird es in der Standardeinstellung ausgeführt. +Führe das Skript auf der Seite aus. Analysiere nur das erste script tag ([demo](de-de/themes.md)). Sollte Vue verwendet sein, wird es in der Standardeinstellung ausgeführt. ```js window.$docsify = { @@ -294,7 +294,7 @@ window.$docsify = { ``` -?> Nehme zur Kenntnis, dass, solltest du ein externes Skript ausführen, z.B. ein eingebettete jsfiddle demo, du sicher gehen solltest, das [external-script](plugins?id=external-script) plugin zu verwenden. +?> Nehme zur Kenntnis, dass, solltest du ein externes Skript ausführen, z.B. ein eingebettete jsfiddle demo, du sicher gehen solltest, das [external-script](de-de/plugins.md?id=external-script) plugin zu verwenden. ## no-emoji diff --git a/docs/de-de/cover.md b/docs/de-de/cover.md index 8fcbbf906..b64f0c11a 100644 --- a/docs/de-de/cover.md +++ b/docs/de-de/cover.md @@ -1,6 +1,6 @@ # Titelseite -Aktiviere die Unterstützung für Titelseiten, indem du `coverpage` auf **true** einstellst, vergleiche [coverpage Einstellungen](/de-de/configuration#coverpage). +Aktiviere die Unterstützung für Titelseiten, indem du `coverpage` auf **true** einstellst, vergleiche [coverpage Einstellungen](configuration.md#coverpage). ## Einfache Verwendung diff --git a/docs/de-de/custom-navbar.md b/docs/de-de/custom-navbar.md index 7373e5e33..7ec8681f0 100644 --- a/docs/de-de/custom-navbar.md +++ b/docs/de-de/custom-navbar.md @@ -20,7 +20,7 @@ Solltest du eine Navigationsleiste benötigen, so kannst du eine HTML-basierte e ## Markdown -Oder du kannst deine Navigationsleiste mit einer Datei basierend auf Markdown erstellen, indem du `loadNavbar` auf **true** setzt und eine Datei namens `_navbar.md` erstellst, vergleiche [load-navbar Einstellungen](/de-de/configuration#load-navbar). +Oder du kannst deine Navigationsleiste mit einer Datei basierend auf Markdown erstellen, indem du `loadNavbar` auf **true** setzt und eine Datei namens `_navbar.md` erstellst, vergleiche [load-navbar Einstellungen](configuration.md#load-navbar). ```html @@ -52,17 +52,17 @@ Du kannst untergeordnete Listen erstellen, indem du untergeordnete Punkte einem - Getting started - - [Quick start](/quickstart) - - [Writing more pages](/more-pages) - - [Custom navbar](/custom-navbar) - - [Cover page](/cover) + - [Quick start](de-de/quickstart.md) + - [Writing more pages](de-de/more-pages.md) + - [Custom navbar](de-de/custom-navbar.md) + - [Cover page](de-de/cover.md) - Configuration - - [Configuration](/configuration) - - [Themes](/themes) - - [Using plugins](/plugins) - - [Markdown configuration](/markdown) - - [Language highlight](/language-highlight) + - [Configuration](de-de/configuration.md) + - [Themes](de-de/themes.md) + - [Using plugins](de-de/plugins.md) + - [Markdown configuration](de-de/markdown.md) + - [Language highlight](de-de/language-highlight.md) ``` wird also wie folgt aussehen @@ -71,7 +71,7 @@ wird also wie folgt aussehen ## Angepasste Navigationsleisten in Verbindung mit dem emoji Erweiterung -Solltest du die [emoji Erweiterung](/de-de/plugins#emoji) verwenden: +Solltest du die [emoji Erweiterung](plugins.md#emoji) verwenden: ```html diff --git a/docs/de-de/more-pages.md b/docs/de-de/more-pages.md index 3748502b2..1d32fc7a3 100644 --- a/docs/de-de/more-pages.md +++ b/docs/de-de/more-pages.md @@ -27,7 +27,7 @@ docs/de-de/guide.md => http://domain.com/de-de/guide Als Standardeinstellung wird das Inhaltsverzeichnis in der Seitenleiste automatisch basierend auf vorhandenen Markdown Dateien generiert. Wenn du das seitliche Inhaltsverzeichnis anpassen willst, kannst du eine Datei namens `_sidebar.md` erstellen (vergleiche [das seitliche Inhaltsverzeichnis für diese Dokumentation](https://github.com/QingWei-Li/docsify/blob/master/docs/de-de/_sidebar.md) als Beispiel): -Als Erstes musst du `loadSidebar` auf **true** setzen, vergleiche [Einstellungen für das seitliche Inhaltsverzeichnis](/de-de/configuration#load-sidebar). +Als Erstes musst du `loadSidebar` auf **true** setzen, vergleiche [Einstellungen für das seitliche Inhaltsverzeichnis](configuration.md#load-sidebar). ```html @@ -46,7 +46,7 @@ Als Zweites erstellst du eine Datei namens `_sidebar.md`: - [Home](/) -- [Guide](/guide) +- [Guide](de-de/guide.md) ``` !> Solltest du Github Pages verwenden, musst du zusätzlich eine Datei namens `.nojekyll` in `./docs` erstellen, um zu verhindern, dass Github Dateien ignoriert, die mit einem Unterstrich anfangen. @@ -55,7 +55,7 @@ Als Zweites erstellst du eine Datei namens `_sidebar.md`: ## Inhaltsverzeichnis -Eine angepasste Seitenleist kann auch automatisch ein Inhaltsverzeichnis generieren, indem ein `subMaxLevel` gesetzt wird, vergleiche [sub-max-level Einstellungen](/de-de/configuration#sub-max-level). +Eine angepasste Seitenleist kann auch automatisch ein Inhaltsverzeichnis generieren, indem ein `subMaxLevel` gesetzt wird, vergleiche [sub-max-level Einstellungen](configuration.md#sub-max-level). ```html diff --git a/docs/de-de/quickstart.md b/docs/de-de/quickstart.md index 61e48b727..ba2e06788 100644 --- a/docs/de-de/quickstart.md +++ b/docs/de-de/quickstart.md @@ -22,7 +22,7 @@ Nachdem der Befehl `init` vollständig ausgeführt wurde, kannst du folgende Dat * `README.md` als die Startseite für die Dokumentation * `.nojekyll` verhindert, dass Github Pages Dateien ignoriert, die mit einem Unterstrich beginnen. -Du kannst die Dokumentation über die Datei `./docs/README.md` nach Belieben ändern, und natürlich [weitere Seiten](/de-de/more-pages) hinzufügen. +Du kannst die Dokumentation über die Datei `./docs/README.md` nach Belieben ändern, und natürlich [weitere Seiten](de-de/more-pages.md) hinzufügen. ## Vorschau der eigenen Seiten @@ -84,4 +84,4 @@ Du solltest das `data-app` Attribut anpassen, wenn du `el` geändert hast: ``` -Vergleiche [el Einstellungen](/de-de/configuration#el). +Vergleiche [el Einstellungen](configuration.md#el). diff --git a/docs/more-pages.md b/docs/more-pages.md index dbe2e7f9c..b9db3a961 100644 --- a/docs/more-pages.md +++ b/docs/more-pages.md @@ -27,7 +27,7 @@ docs/zh-cn/guide.md => http://domain.com/zh-cn/guide By default, the table of contents in the sidebar is automatically generated based on your markdown files. If you need a custom sidebar, then you can create your own `_sidebar.md` (see [this documentation's sidebar](https://github.com/QingWei-Li/docsify/blob/master/docs/_sidebar.md) for an example): -First, you need to set `loadSidebar` to **true**. Details are available in the [configuration paragraph](configuration#load-sidebar). +First, you need to set `loadSidebar` to **true**. Details are available in the [configuration paragraph](configuration.md#load-sidebar). ```html @@ -46,7 +46,7 @@ Create the `_sidebar.md`: - [Home](/) -- [Guide](/guide) +- [Guide](guide.md) ``` !> You need to create a `.nojekyll` in `./docs` to prevent GitHub Pages from ignoring files that begin with an underscore. @@ -55,7 +55,7 @@ Create the `_sidebar.md`: ## Table of Contents -A custom sidebar can also automatically generate a table of contents by setting a `subMaxLevel`, compare [sub-max-level configuration](configuration#sub-max-level). +A custom sidebar can also automatically generate a table of contents by setting a `subMaxLevel`, compare [sub-max-level configuration](configuration.md#sub-max-level). ```html diff --git a/docs/quickstart.md b/docs/quickstart.md index 7e3df3902..7bcc0913b 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -22,7 +22,7 @@ After the `init` is complete, you can see the file list in the `./docs` subdirec * `README.md` as the home page * `.nojekyll` prevents GitHub Pages from ignoring files that begin with an underscore -You can easily update the documentation in `./docs/README.md`, of course you can add [more pages](more-pages). +You can easily update the documentation in `./docs/README.md`, of course you can add [more pages](more-pages.md). ## Preview your site @@ -84,4 +84,4 @@ You should set the `data-app` attribute if you changed `el`: ``` -Compare [el configuration](/configuration#el). +Compare [el configuration](configuration.md#el). diff --git a/docs/zh-cn/README.md b/docs/zh-cn/README.md index 4d5c1a3ce..5bc5f75ad 100644 --- a/docs/zh-cn/README.md +++ b/docs/zh-cn/README.md @@ -6,9 +6,9 @@ docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 `.md` 转成 `.html` 文件，所有转换工作都是在运行时进行。 -这将非常实用，如果只是需要快速的搭建一个小型的文档网站，或者不想因为生成的一堆 `.html` 文件“污染” commit 记录，只需要创建一个 `index.html` 就可以开始写文档而且直接[部署在 GitHub Pages](zh-cn/deploy)。 +这将非常实用，如果只是需要快速的搭建一个小型的文档网站，或者不想因为生成的一堆 `.html` 文件“污染” commit 记录，只需要创建一个 `index.html` 就可以开始写文档而且直接[部署在 GitHub Pages](zh-cn/deploy.md)。 -查看[快速开始](zh-cn/quickstart)了解详情。 +查看[快速开始](zh-cn/quickstart.md)了解详情。 ## 特性 - 无需构建，写完文档直接发布 diff --git a/docs/zh-cn/_navbar.md b/docs/zh-cn/_navbar.md index 47bc8f75f..87019b516 100644 --- a/docs/zh-cn/_navbar.md +++ b/docs/zh-cn/_navbar.md @@ -1,4 +1,4 @@ - :cn: - [:cn: 中文](/zh-cn/) - - [:de: German](/de-de/) + - [:de: Deutsch](/de-de/) - [:uk: English](/) diff --git a/docs/zh-cn/_sidebar.md b/docs/zh-cn/_sidebar.md index 1802cf669..f03656654 100644 --- a/docs/zh-cn/_sidebar.md +++ b/docs/zh-cn/_sidebar.md @@ -1,22 +1,22 @@ - 入门 - - [快速开始](zh-cn/quickstart) - - [多页文档](zh-cn/more-pages) - - [定制导航栏](zh-cn/custom-navbar) - - [封面](zh-cn/cover) + - [快速开始](zh-cn/quickstart.md) + - [多页文档](zh-cn/more-pages.md) + - [定制导航栏](zh-cn/custom-navbar.md) + - [封面](zh-cn/cover.md) - 定制化 - - [配置项](zh-cn/configuration) - - [主题](zh-cn/themes) - - [插件列表](zh-cn/plugins) - - [开发插件](zh-cn/write-a-plugin) - - [Markdown 配置](zh-cn/markdown) - - [代码高亮](zh-cn/language-highlight) + - [配置项](zh-cn/configuration.md) + - [主题](zh-cn/themes.md) + - [插件列表](zh-cn/plugins.md) + - [开发插件](zh-cn/write-a-plugin.md) + - [Markdown 配置](zh-cn/markdown.md) + - [代码高亮](zh-cn/language-highlight.md) - 指南 - - [部署](zh-cn/deploy) - - [文档助手](zh-cn/helpers) - - [兼容 Vue](zh-cn/vue) - - [CDN](zh-cn/cdn) - - [离线模式(PWA)](zh-cn/pwa) + - [部署](zh-cn/deploy.md) + - [文档助手](zh-cn/helpers.md) + - [兼容 Vue](zh-cn/vue.md) + - [CDN](zh-cn/cdn.md) + - [离线模式(PWA)](zh-cn/pwa.md) -- [Changelog](zh-cn/changelog) +- [Changelog](zh-cn/changelog.md) diff --git a/docs/zh-cn/configuration.md b/docs/zh-cn/configuration.md index 3ef44c056..ef7a73096 100644 --- a/docs/zh-cn/configuration.md +++ b/docs/zh-cn/configuration.md @@ -74,7 +74,7 @@ window.$docsify = { - 类型：`Boolean|String` - 默认值: `false` -加载自定义导航栏，参考[定制导航栏](zh-cn/custom-navbar) 了解用法。设置为 `true` 后会加载 `_navbar.md` 文件，也可以自定义加载的文件名。 +加载自定义导航栏，参考[定制导航栏](zh-cn/custom-navbar.md) 了解用法。设置为 `true` 后会加载 `_navbar.md` 文件，也可以自定义加载的文件名。 ```js window.$docsify = { @@ -91,7 +91,7 @@ window.$docsify = { - 类型：`Boolean|String` - 默认值: `false` -加载自定义侧边栏，参考[多页文档](zh-cn/more-pages)。设置为 `true` 后会加载 `_sidebar.md` 文件，也可以自定义加载的文件名。 +加载自定义侧边栏，参考[多页文档](zh-cn/more-pages.md)。设置为 `true` 后会加载 `_sidebar.md` 文件，也可以自定义加载的文件名。 ```js window.$docsify = { @@ -173,7 +173,7 @@ window.$docsify = { - 类型：`Boolean|String` - 默认值: `false` -启用[封面页](/zh-cn/cover)。开启后是加载 `_coverpage.md` 文件，也可以自定义文件名。 +启用[封面页](zh-cn/cover.md)。开启后是加载 `_coverpage.md` 文件，也可以自定义文件名。 ```js window.$docsify = { @@ -220,7 +220,7 @@ window.$docsify = { - 类型: `Object|Function` -参考 [Markdown 配置](/zh-cn/markdown)。 +参考 [Markdown 配置](zh-cn/markdown.md)。 ```js window.$docsify = { @@ -287,7 +287,7 @@ window.$docsify = { - 类型：`Boolean` -执行文档里的 script 标签里的脚本，只执行第一个 script ([demo](zh-cn/themes))。 如果 Vue 存在，则自动开启。 +执行文档里的 script 标签里的脚本，只执行第一个 script ([demo](zh-cn/themes.md))。 如果 Vue 存在，则自动开启。 ```js window.$docsify = { @@ -304,7 +304,7 @@ window.$docsify = { ``` -注意如果执行的是一个外链脚本，比如 jsfiddle 的内嵌 demo，请确保引入 [external-script](zh-cn/plugins?id=外链脚本-external-script) 插件。 +注意如果执行的是一个外链脚本，比如 jsfiddle 的内嵌 demo，请确保引入 [external-script](plugins.md?id=外链脚本-external-script) 插件。 ## no-emoji diff --git a/docs/zh-cn/cover.md b/docs/zh-cn/cover.md index 01efe7107..92f9425c0 100644 --- a/docs/zh-cn/cover.md +++ b/docs/zh-cn/cover.md @@ -1,6 +1,6 @@ # 封面 -通过设置 `coverpage` 参数，可以开启渲染封面的功能。具体用法见[配置项#coverpage](zh-cn/configuration#coverpage)。 +通过设置 `coverpage` 参数，可以开启渲染封面的功能。具体用法见[配置项#coverpage](configuration.md#coverpage)。 ## 基本用法 diff --git a/docs/zh-cn/custom-navbar.md b/docs/zh-cn/custom-navbar.md index 567086560..ccb97d309 100644 --- a/docs/zh-cn/custom-navbar.md +++ b/docs/zh-cn/custom-navbar.md @@ -17,7 +17,7 @@ ## 配置文件 -那我们可以通过 Markdown 文件来配置导航。首先配置 `loadNavbar`，默认加载的文件为 `_navbar.md`。具体配置规则见[配置项#load-navbar](zh-cn/configuration#load-navbar)。 +那我们可以通过 Markdown 文件来配置导航。首先配置 `loadNavbar`，默认加载的文件为 `_navbar.md`。具体配置规则见[配置项#load-navbar](configuration.md#load-navbar)。 *index.html* @@ -49,17 +49,17 @@ ```markdown - 基础 - - [快速开始](zh-cn/quickstart) - - [多页文档](zh-cn/more-pages) - - [定制导航栏](zh-cn/custom-navbar) - - [封面](zh-cn/cover) + - [快速开始](zh-cn/quickstart.md) + - [多页文档](zh-cn/more-pages.md) + - [定制导航栏](zh-cn/custom-navbar.md) + - [封面](zh-cn/cover.md) - 配置 - - [配置项](zh-cn/configuration) - - [主题](zh-cn/themes) - - [使用插件](zh-cn/plugins) - - [Markdown 配置](zh-cn/markdown) - - [代码高亮](zh-cn/language-highlight) + - [配置项](zh-cn/configuration.md) + - [主题](zh-cn/themes.md) + - [使用插件](zh-cn/plugins.md) + - [Markdown 配置](zh-cn/markdown.md) + - [代码高亮](zh-cn/language-highlight.md) ``` 效果图 diff --git a/docs/zh-cn/more-pages.md b/docs/zh-cn/more-pages.md index ae5152180..477cc41b5 100644 --- a/docs/zh-cn/more-pages.md +++ b/docs/zh-cn/more-pages.md @@ -26,7 +26,7 @@ docs/zh-cn/guide.md => http://domain.com/zh-cn/guide 默认情况下，侧边栏会根据当前文档的标题生成目录。也可以设置文档链接，通过 Markdown 文件生成，效果如当前的文档的侧边栏。 -首先配置 `loadSidebar` 选项，具体配置规则见[配置项#load-sidebar](zh-cn/configuration#load-sidebar)。 +首先配置 `loadSidebar` 选项，具体配置规则见[配置项#load-sidebar](configuration.md#load-sidebar)。 ```html