From 7fb5ce6c846b6562dd522573b41d53e270c3c095 Mon Sep 17 00:00:00 2001 From: "qingwei.li" Date: Mon, 10 Jul 2017 22:23:09 +0800 Subject: [PATCH] docs: add alias --- docs/configuration.md | 17 ++++++++++++++++- docs/de-de/configuration.md | 5 +++-- docs/index.html | 4 +--- docs/zh-cn/configuration.md | 6 ++++-- 4 files changed, 24 insertions(+), 8 deletions(-) diff --git a/docs/configuration.md b/docs/configuration.md index 5dece4507..1e76bf906 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -250,11 +250,12 @@ window.$docsify = { - Type: `Object` -Set the route alias. You can freely manage routing rules. +Set the route alias. You can freely manage routing rules. Supports RegExp. ```js window.$docsify = { alias: { + '/foo/(+*)': '/bar/$1', // supports regexp '/zh-cn/changelog': '/changelog', '/changelog': 'https://github.com/raw/QingWei-Li/docsify/master/CHANGELOG' } @@ -298,6 +299,8 @@ Note that if you are running an external script, e.g. an embedded jsfiddle demo, ## no-emoji +- type: `Boolean` + Disabled emoji parse. ```js @@ -308,6 +311,8 @@ window.$docsify = { ## merge-navbar +- type: `Boolean` + Navbar will be merged with the sidebar on smaller screens. ```js @@ -317,6 +322,9 @@ window.$docsify = { ``` ## format-updated + +- type: `String|Function` + We can display the file update date through **{docsify-updated}** variable. And format it by `formatUpdated`. See https://github.com/lukeed/tinydate#patterns ```js @@ -333,6 +341,9 @@ window.$docsify = { ## external-link-target +- type: `String` +- default: `_self` + Target to open external links. Default `'_blank'` (new window/tab) ```js @@ -342,6 +353,10 @@ window.$docsify = { ``` ## router-mode + +- type: `String` +- default: `history` + ```js window.$docsify = { routerMode: 'history' // default: 'hash' diff --git a/docs/de-de/configuration.md b/docs/de-de/configuration.md index 1cd539bbc..5c3b57ff8 100644 --- a/docs/de-de/configuration.md +++ b/docs/de-de/configuration.md @@ -250,11 +250,12 @@ window.$docsify = { - Typ: `Object` -Verwende alternative Routen. Du kannst sie ungehindert anpassen. +Verwende alternative Routen. Du kannst sie ungehindert anpassen. Supports RegExp. ```js window.$docsify = { alias: { + '/foo/(+*)': '/bar/$1', // supports regexp '/zh-cn/changelog': '/changelog', '/changelog': 'https://github.com/raw/QingWei-Li/docsify/master/CHANGELOG' } @@ -317,7 +318,7 @@ window.$docsify = { ``` ## format-updated -We can display the file update date through **{docsify-updated}** variable. And format it by `formatUpdated`. +We can display the file update date through **{docsify-updated}** variable. And format it by `formatUpdated`. See https://github.com/lukeed/tinydate#patterns ```js window.$docsify = { diff --git a/docs/index.html b/docs/index.html index 760317f8e..5790b7204 100644 --- a/docs/index.html +++ b/docs/index.html @@ -23,9 +23,7 @@