Skip to content

Commit

Permalink
feat(route): auto remove .md extension
Browse files Browse the repository at this point in the history
  • Loading branch information
QingWei-Li committed Mar 25, 2017
1 parent 6aae64f commit 8f11653
Show file tree
Hide file tree
Showing 23 changed files with 115 additions and 114 deletions.
2 changes: 1 addition & 1 deletion dev.html
Original file line number Diff line number Diff line change
Expand Up @@ -32,5 +32,5 @@
subMaxLevel: 2
}
</script>
<script src="/lib/docsify.min.js"></script>
<script src="/lib/docsify.js"></script>
</html>
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
32 changes: 16 additions & 16 deletions docs/_sidebar.md
Original file line number Diff line number Diff line change
@@ -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)
6 changes: 3 additions & 3 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {
Expand Down Expand Up @@ -212,7 +212,7 @@ window.$docsify = {

- Type: `Function`

See [Markdown configuration](/markdown).
See [Markdown configuration](markdown.md).

```js
window.$docsify = {
Expand Down Expand Up @@ -294,7 +294,7 @@ window.$docsify = {
</script>
```

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

Expand Down
2 changes: 1 addition & 1 deletion 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**, compare [coverpage configuration](configuration#coverpage).
Activate the cover feature by setting `coverpage` to **true**, compare [coverpage configuration](configuration.md#coverpage).

## Basic usage

Expand Down
20 changes: 10 additions & 10 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 [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
<!-- index.html -->
Expand Down Expand Up @@ -52,17 +52,17 @@ You can create sub-lists by indenting items that are under a certain parent.
<!-- _navbar.md -->

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

Expand Down
32 changes: 16 additions & 16 deletions docs/de-de/_sidebar.md
Original file line number Diff line number Diff line change
@@ -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)
8 changes: 4 additions & 4 deletions docs/de-de/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 = {
Expand Down Expand Up @@ -212,7 +212,7 @@ window.$docsify = {

- Typ: `Function`

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

```js
window.$docsify = {
Expand Down Expand Up @@ -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 = {
Expand All @@ -294,7 +294,7 @@ window.$docsify = {
</script>
```

?> 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

Expand Down
2 changes: 1 addition & 1 deletion docs/de-de/cover.md
Original file line number Diff line number Diff line change
@@ -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

Expand Down
22 changes: 11 additions & 11 deletions docs/de-de/custom-navbar.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<!-- index.html -->
Expand Down Expand Up @@ -52,17 +52,17 @@ Du kannst untergeordnete Listen erstellen, indem du untergeordnete Punkte einem
<!-- _navbar.md -->

- 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
Expand All @@ -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
<!-- index.html -->
Expand Down
6 changes: 3 additions & 3 deletions docs/de-de/more-pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
<!-- index.html -->
Expand All @@ -46,7 +46,7 @@ Als Zweites erstellst du eine Datei namens `_sidebar.md`:
<!-- docs/_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.
Expand All @@ -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
<!-- index.html -->
Expand Down
4 changes: 2 additions & 2 deletions docs/de-de/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

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

Vergleiche [el Einstellungen](/de-de/configuration#el).
Vergleiche [el Einstellungen](configuration.md#el).
6 changes: 3 additions & 3 deletions docs/more-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

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
<!-- index.html -->
Expand All @@ -46,7 +46,7 @@ Create the `_sidebar.md`:
<!-- docs/_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.
Expand All @@ -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
<!-- index.html -->
Expand Down
4 changes: 2 additions & 2 deletions docs/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -84,4 +84,4 @@ You should set the `data-app` attribute if you changed `el`:
</script>
```

Compare [el configuration](/configuration#el).
Compare [el configuration](configuration.md#el).
4 changes: 2 additions & 2 deletions docs/zh-cn/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)了解详情。

## 特性
- 无需构建,写完文档直接发布
Expand Down
Loading

0 comments on commit 8f11653

Please sign in to comment.