https://github.com/petrbroz/docsify-lang-test
Experimenting with Docsify's localization support.
https://github.com/petrbroz/docsify-lang-test
Last synced: 6 months ago
JSON representation
Experimenting with Docsify's localization support.
- Host: GitHub
- URL: https://github.com/petrbroz/docsify-lang-test
- Owner: petrbroz
- Created: 2021-07-14T13:53:17.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-07-15T14:18:15.000Z (about 4 years ago)
- Last Synced: 2025-02-17T20:41:28.149Z (8 months ago)
- Homepage: https://petrbroz.github.io/docsify-lang-test
- Size: 1.61 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# docsify-lang-test
Experimental [Docsify.js](https://github.com/docsifyjs/docsify) project exploring
different ways to enable multilingual documentation.
## Notes
- Docsify does not provide localization out-of-the-box.
- Docsify's own [homepage](https://docsify.js.org) handles multi-language content
by aliasing URLs to separate GitHub repos:
```js
window.$docsify = {
alias: {
// ...
"/zh-cn/(.*)": "https://cdn.jsdelivr.net/gh/docsifyjs/docs-zh@master/$1",
"/de-de/(.*)": "https://raw.githubusercontent.com/docsifyjs/docs-de/master/$1",
"/ru-ru/(.*)": "https://raw.githubusercontent.com/docsifyjs/docs-ru/master/$1",
"/es/(.*)": "https://raw.githubusercontent.com/docsifyjs/docs-es/master/$1",
// ...
},
};
```
- Not sure if we want to do the same; we can probably just keep all languages
in the same repo, as demonstrated in this experimental project.
- There seems to be a problem with path resolution for embedded images or code snippets,
see issues [#850](https://github.com/docsifyjs/docsify/issues/850),
[#877](https://github.com/docsifyjs/docsify/issues/877), and pull request
[#1339](https://github.com/docsifyjs/docsify/pull/1339). For now, paths to shared images
and code snippets must be relative, e.g., `[hello.js](../../../_snippets/hello.js ':include :type=code')`.