Skip to content

Commit 8f11653

Browse files
committed
feat(route): auto remove .md extension
1 parent 6aae64f commit 8f11653

23 files changed

+115
-114
lines changed

dev.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,5 +32,5 @@
3232
subMaxLevel: 2
3333
}
3434
</script>
35-
<script src="/lib/docsify.min.js"></script>
35+
<script src="/lib/docsify.js"></script>
3636
</html>

docs/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
55
## What is it
66

7-
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).
7+
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).
88

9-
See the [Quick start](/quickstart) for more details.
9+
See the [Quick start](quickstart.md) for more details.
1010

1111
## Features
1212

docs/_sidebar.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
- Getting started
2-
- [Quick start](/quickstart)
3-
- [Writing more pages](/more-pages)
4-
- [Custom navbar](/custom-navbar)
5-
- [Cover page](/cover)
2+
- [Quick start](quickstart.md)
3+
- [Writing more pages](more-pages.md)
4+
- [Custom navbar](custom-navbar.md)
5+
- [Cover page](cover.md)
66

77
- Customization
8-
- [Configuration](/configuration)
9-
- [Themes](/themes)
10-
- [List of Plugins](/plugins)
11-
- [Write a Plugin](/write-a-plugin)
12-
- [Markdown configuration](/markdown)
13-
- [Language highlighting](/language-highlight)
8+
- [Configuration](configuration.md)
9+
- [Themes](themes.md)
10+
- [List of Plugins](plugins.md)
11+
- [Write a Plugin](write-a-plugin.md)
12+
- [Markdown configuration](markdown.md)
13+
- [Language highlighting](language-highlight.md)
1414

1515
- Guide
16-
- [Deploy](/deploy)
17-
- [Helpers](/helpers)
18-
- [Vue compatibility](/vue)
19-
- [CDN](/cdn)
20-
- [Offline Mode(PWA)](/pwa)
16+
- [Deploy](deploy.md)
17+
- [Helpers](helpers.md)
18+
- [Vue compatibility](vue.md)
19+
- [CDN](cdn.md)
20+
- [Offline Mode(PWA)](pwa.md)
2121

22-
- [Changelog](/changelog)
22+
- [Changelog](changelog.md)

docs/configuration.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ window.$docsify = {
166166
- Type: `Boolean|String`
167167
- Default: `false`
168168

169-
Activate the [cover feature](/cover). If true, it will load from `_coverpage.md`.
169+
Activate the [cover feature](cover.md). If true, it will load from `_coverpage.md`.
170170

171171
```js
172172
window.$docsify = {
@@ -212,7 +212,7 @@ window.$docsify = {
212212

213213
- Type: `Function`
214214

215-
See [Markdown configuration](/markdown).
215+
See [Markdown configuration](markdown.md).
216216

217217
```js
218218
window.$docsify = {
@@ -294,7 +294,7 @@ window.$docsify = {
294294
</script>
295295
```
296296

297-
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.
297+
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.
298298

299299
## no-emoji
300300

docs/cover.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Cover
22

3-
Activate the cover feature by setting `coverpage` to **true**, compare [coverpage configuration](configuration#coverpage).
3+
Activate the cover feature by setting `coverpage` to **true**, compare [coverpage configuration](configuration.md#coverpage).
44

55
## Basic usage
66

docs/custom-navbar.md

+10-10
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ If you need custom navigation, you can create a HTML-based navigation bar.
2020

2121
## Markdown
2222

23-
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).
23+
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).
2424

2525
```html
2626
<!-- index.html -->
@@ -52,17 +52,17 @@ You can create sub-lists by indenting items that are under a certain parent.
5252
<!-- _navbar.md -->
5353

5454
- Getting started
55-
- [Quick start](/quickstart)
56-
- [Writing more pages](/more-pages)
57-
- [Custom navbar](/custom-navbar)
58-
- [Cover page](/cover)
55+
- [Quick start](quickstart.md)
56+
- [Writing more pages](more-pages.md)
57+
- [Custom navbar](custom-navbar.md)
58+
- [Cover page](cover.md)
5959

6060
- Configuration
61-
- [Configuration](/configuration)
62-
- [Themes](/themes)
63-
- [Using plugins](/plugins)
64-
- [Markdown configuration](/markdown)
65-
- [Language highlight](/language-highlight)
61+
- [Configuration](configuration.md)
62+
- [Themes](themes.md)
63+
- [Using plugins](plugins.md)
64+
- [Markdown configuration](markdown.md)
65+
- [Language highlight](language-highlight.md)
6666
```
6767

6868
renders as

docs/de-de/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44
55
## Was ist das
66

7-
**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).
7+
**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).
88

9-
Siehe [Schnellstart](/de-de/quickstart) für weitere Informationen.
9+
Siehe [Schnellstart](de-de/quickstart.md) für weitere Informationen.
1010

1111
## Features
1212

docs/de-de/_sidebar.md

+16-16
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
- Loslegen
2-
- [Schnellstart](/de-de/quickstart)
3-
- [Schreiben weiterer Seiten](/de-de/more-pages)
4-
- [Navigationsleiste anpassen](/de-de/custom-navbar)
5-
- [Titelseite](/de-de/cover)
2+
- [Schnellstart](de-de/quickstart.md)
3+
- [Schreiben weiterer Seiten](de-de/more-pages.md)
4+
- [Navigationsleiste anpassen](de-de/custom-navbar.md)
5+
- [Titelseite](de-de/cover.md)
66

77
- Anpassen
8-
- [Einstellungen](/de-de/configuration)
9-
- [Themen](/de-de/themes)
10-
- [Liste der Erweiterungen](/de-de/plugins)
11-
- [Schreiben eigener Erweiterungen](/de-de/write-a-plugin)
12-
- [Markdown-Einstellungen](/de-de/markdown)
13-
- [Hervorheben von Sprachen](/de-de/language-highlight)
8+
- [Einstellungen](de-de/configuration.md)
9+
- [Themen](de-de/themes.md)
10+
- [Liste der Erweiterungen](de-de/plugins.md)
11+
- [Schreiben eigener Erweiterungen](de-de/write-a-plugin.md)
12+
- [Markdown-Einstellungen](de-de/markdown.md)
13+
- [Hervorheben von Sprachen](de-de/language-highlight.md)
1414

1515
- Guide
16-
- [Inbetriebnahme](/de-de/deploy)
17-
- [Helfer](/de-de/helpers)
18-
- [Vue Kompatibilität](/de-de/vue)
19-
- [CDN](/de-de/cdn)
20-
- [Offline Modus (PWA)](/de-de/pwa)
16+
- [Inbetriebnahme](de-de/deploy.md)
17+
- [Helfer](de-de/helpers.md)
18+
- [Vue Kompatibilität](de-de/vue.md)
19+
- [CDN](de-de/cdn.md)
20+
- [Offline Modus (PWA)](de-de/pwa.md)
2121

22-
- [Changelog](/de-de/changelog)
22+
- [Changelog](de-de/changelog.md)

docs/de-de/configuration.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@ window.$docsify = {
166166
- Typ: `Boolean|String`
167167
- Standard: `false`
168168

169-
Aktiviere das [Titelseitenfeature](/de-de/cover). Falls `true`, wird sie von `_coverpage.md` geladen.
169+
Aktiviere das [Titelseitenfeature](de-de/cover.md). Falls `true`, wird sie von `_coverpage.md` geladen.
170170

171171
```js
172172
window.$docsify = {
@@ -212,7 +212,7 @@ window.$docsify = {
212212

213213
- Typ: `Function`
214214

215-
Siehe [Markdown Konfiguration](/de-de/markdown).
215+
Siehe [Markdown Konfiguration](de-de/markdown.md).
216216

217217
```js
218218
window.$docsify = {
@@ -278,7 +278,7 @@ window.$docsify = {
278278

279279
- Typ: `Boolean`
280280

281-
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.
281+
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.
282282

283283
```js
284284
window.$docsify = {
@@ -294,7 +294,7 @@ window.$docsify = {
294294
</script>
295295
```
296296

297-
?> 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.
297+
?> 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.
298298

299299
## no-emoji
300300

docs/de-de/cover.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Titelseite
22

3-
Aktiviere die Unterstützung für Titelseiten, indem du `coverpage` auf **true** einstellst, vergleiche [coverpage Einstellungen](/de-de/configuration#coverpage).
3+
Aktiviere die Unterstützung für Titelseiten, indem du `coverpage` auf **true** einstellst, vergleiche [coverpage Einstellungen](configuration.md#coverpage).
44

55
## Einfache Verwendung
66

docs/de-de/custom-navbar.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Solltest du eine Navigationsleiste benötigen, so kannst du eine HTML-basierte e
2020

2121
## Markdown
2222

23-
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).
23+
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).
2424

2525
```html
2626
<!-- index.html -->
@@ -52,17 +52,17 @@ Du kannst untergeordnete Listen erstellen, indem du untergeordnete Punkte einem
5252
<!-- _navbar.md -->
5353

5454
- Getting started
55-
- [Quick start](/quickstart)
56-
- [Writing more pages](/more-pages)
57-
- [Custom navbar](/custom-navbar)
58-
- [Cover page](/cover)
55+
- [Quick start](de-de/quickstart.md)
56+
- [Writing more pages](de-de/more-pages.md)
57+
- [Custom navbar](de-de/custom-navbar.md)
58+
- [Cover page](de-de/cover.md)
5959

6060
- Configuration
61-
- [Configuration](/configuration)
62-
- [Themes](/themes)
63-
- [Using plugins](/plugins)
64-
- [Markdown configuration](/markdown)
65-
- [Language highlight](/language-highlight)
61+
- [Configuration](de-de/configuration.md)
62+
- [Themes](de-de/themes.md)
63+
- [Using plugins](de-de/plugins.md)
64+
- [Markdown configuration](de-de/markdown.md)
65+
- [Language highlight](de-de/language-highlight.md)
6666
```
6767

6868
wird also wie folgt aussehen
@@ -71,7 +71,7 @@ wird also wie folgt aussehen
7171

7272
## Angepasste Navigationsleisten in Verbindung mit dem emoji Erweiterung
7373

74-
Solltest du die [emoji Erweiterung](/de-de/plugins#emoji) verwenden:
74+
Solltest du die [emoji Erweiterung](plugins.md#emoji) verwenden:
7575

7676
```html
7777
<!-- index.html -->

docs/de-de/more-pages.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ docs/de-de/guide.md => http://domain.com/de-de/guide
2727

2828
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):
2929

30-
Als Erstes musst du `loadSidebar` auf **true** setzen, vergleiche [Einstellungen für das seitliche Inhaltsverzeichnis](/de-de/configuration#load-sidebar).
30+
Als Erstes musst du `loadSidebar` auf **true** setzen, vergleiche [Einstellungen für das seitliche Inhaltsverzeichnis](configuration.md#load-sidebar).
3131

3232
```html
3333
<!-- index.html -->
@@ -46,7 +46,7 @@ Als Zweites erstellst du eine Datei namens `_sidebar.md`:
4646
<!-- docs/_sidebar.md -->
4747

4848
- [Home](/)
49-
- [Guide](/guide)
49+
- [Guide](de-de/guide.md)
5050
```
5151

5252
!> 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`:
5555

5656
## Inhaltsverzeichnis
5757

58-
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).
58+
Eine angepasste Seitenleist kann auch automatisch ein Inhaltsverzeichnis generieren, indem ein `subMaxLevel` gesetzt wird, vergleiche [sub-max-level Einstellungen](configuration.md#sub-max-level).
5959

6060
```html
6161
<!-- index.html -->

docs/de-de/quickstart.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ Nachdem der Befehl `init` vollständig ausgeführt wurde, kannst du folgende Dat
2222
* `README.md` als die Startseite für die Dokumentation
2323
* `.nojekyll` verhindert, dass Github Pages Dateien ignoriert, die mit einem Unterstrich beginnen.
2424

25-
Du kannst die Dokumentation über die Datei `./docs/README.md` nach Belieben ändern, und natürlich [weitere Seiten](/de-de/more-pages) hinzufügen.
25+
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.
2626

2727
## Vorschau der eigenen Seiten
2828

@@ -84,4 +84,4 @@ Du solltest das `data-app` Attribut anpassen, wenn du `el` geändert hast:
8484
</script>
8585
```
8686

87-
Vergleiche [el Einstellungen](/de-de/configuration#el).
87+
Vergleiche [el Einstellungen](configuration.md#el).

docs/more-pages.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ docs/zh-cn/guide.md => http://domain.com/zh-cn/guide
2727

2828
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):
2929

30-
First, you need to set `loadSidebar` to **true**. Details are available in the [configuration paragraph](configuration#load-sidebar).
30+
First, you need to set `loadSidebar` to **true**. Details are available in the [configuration paragraph](configuration.md#load-sidebar).
3131

3232
```html
3333
<!-- index.html -->
@@ -46,7 +46,7 @@ Create the `_sidebar.md`:
4646
<!-- docs/_sidebar.md -->
4747

4848
- [Home](/)
49-
- [Guide](/guide)
49+
- [Guide](guide.md)
5050
```
5151

5252
!> 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`:
5555

5656
## Table of Contents
5757

58-
A custom sidebar can also automatically generate a table of contents by setting a `subMaxLevel`, compare [sub-max-level configuration](configuration#sub-max-level).
58+
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).
5959

6060
```html
6161
<!-- index.html -->

docs/quickstart.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ After the `init` is complete, you can see the file list in the `./docs` subdirec
2222
* `README.md` as the home page
2323
* `.nojekyll` prevents GitHub Pages from ignoring files that begin with an underscore
2424

25-
You can easily update the documentation in `./docs/README.md`, of course you can add [more pages](more-pages).
25+
You can easily update the documentation in `./docs/README.md`, of course you can add [more pages](more-pages.md).
2626

2727
## Preview your site
2828

@@ -84,4 +84,4 @@ You should set the `data-app` attribute if you changed `el`:
8484
</script>
8585
```
8686

87-
Compare [el configuration](/configuration#el).
87+
Compare [el configuration](configuration.md#el).

docs/zh-cn/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@
66

77
docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 `.md` 转成 `.html` 文件,所有转换工作都是在运行时进行。
88

9-
这将非常实用,如果只是需要快速的搭建一个小型的文档网站,或者不想因为生成的一堆 `.html` 文件“污染” commit 记录,只需要创建一个 `index.html` 就可以开始写文档而且直接[部署在 GitHub Pages](zh-cn/deploy)
9+
这将非常实用,如果只是需要快速的搭建一个小型的文档网站,或者不想因为生成的一堆 `.html` 文件“污染” commit 记录,只需要创建一个 `index.html` 就可以开始写文档而且直接[部署在 GitHub Pages](zh-cn/deploy.md)
1010

11-
查看[快速开始](zh-cn/quickstart)了解详情。
11+
查看[快速开始](zh-cn/quickstart.md)了解详情。
1212

1313
## 特性
1414
- 无需构建,写完文档直接发布

0 commit comments

Comments
 (0)