Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(fetch): Add fallback languages configuration. #402

Merged
merged 2 commits into from
Mar 1, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -413,3 +413,25 @@ window.$docsify = {
ext: '.md'
};
```

## fallbackLanguages

* type: `Array<string>`

List of languages that will fallback to the default language when a page is request and didn't exists for the given local.

Example:

- try to fetch the page of `/de/overview`. If this page exists, it'll be displayed
- then try to fetch the default page `/overview` (depending on the default language). If this page exists, it'll be displayed
- then display 404 page.


```js
window.$docsify = {
fallbackLanguages: [
"fr",
"de"
]
};
```
45 changes: 34 additions & 11 deletions src/core/fetch/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,40 @@ export function fetchMixin (proto) {
proto._fetch = function (cb = noop) {
const { path, query } = this.route
const qs = stringifyQuery(query, ['id'])
const { loadNavbar, loadSidebar, requestHeaders } = this.config

const { loadNavbar, loadSidebar, requestHeaders, fallbackLanguages } = this.config
// Abort last request
last && last.abort && last.abort()

const file = this.router.getFile(path)

last = get(file + qs, true, requestHeaders)

// Current page is html
this.isHTML = /\.html$/g.test(file)

const getFallBackPage = (file) => {
if (!fallbackLanguages) {
return false
}

const local = file.split('/')[1]

if (fallbackLanguages.indexOf(local) === -1) {
return false
}

file = file.replace(new RegExp(`^/${local}`), '')

return get(file + qs, true, requestHeaders)
.then(
(text, opt) => {
this._renderMain(text, opt, loadSideAndNav)
},
_ => {
return this._renderMain(null, {}, loadSideAndNav)
}
)
}

const loadSideAndNav = () => {
if (!loadSidebar) return cb()

Expand All @@ -47,14 +69,15 @@ export function fetchMixin (proto) {
}

// Load main content
last.then(
(text, opt) => {
this._renderMain(text, opt, loadSideAndNav)
},
_ => {
this._renderMain(null, {}, loadSideAndNav)
}
)
last
.then(
(text, opt) => {
this._renderMain(text, opt, loadSideAndNav)
},
_ => {
return getFallBackPage(file) || this._renderMain(null, {}, loadSideAndNav)
}
)

// Load nav
loadNavbar &&
Expand Down