https://github.com/mondeja/mkdocs-material-relative-language-selector
Relative access between translations using mkdocs-material theme.
https://github.com/mondeja/mkdocs-material-relative-language-selector
Last synced: 3 months ago
JSON representation
Relative access between translations using mkdocs-material theme.
- Host: GitHub
- URL: https://github.com/mondeja/mkdocs-material-relative-language-selector
- Owner: mondeja
- License: bsd-3-clause
- Created: 2021-06-10T12:20:52.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-09-03T21:10:28.000Z (about 1 year ago)
- Last Synced: 2025-07-04T08:47:10.908Z (3 months ago)
- Language: Python
- Size: 28.3 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# mkdocs-material-relative-language-selector
[![PyPI version][project-pypi-version-badge]][project-pypi-link]
[![Downloads][project-downloads-badge]][project-downloads-link]
Edit the builtin [mkdocs-material site selector][mkdocs-material-ss-link] to
make the links between languages relative.
- If you have in Github Pages the URL `https://foo.github.io/bar/es/config/`,
you can access it from the URL `https://foo.github.io/bar/config/` selecting
Spanish in the language selector.
- The current language being displayed will be removed from the language
selector, so you will only capable to access to other languages than the
current.
## Installation
```
pip install mkdocs-material-relative-language-selector
```
## Example configuration
### With [mkdocs-mdpo-plugin][mkdocs-mdpo-plugin-link]
```yaml
theme:
name: material
language: en
plugins:
- search
- material-relative-language-selector
- mdpo
extra:
alternate:
- name: English
lang: en
- name: Español
link: es
lang: es
```
## Configuration
- If you want to publish your site in Github Pages, you don't need to define any
setting because is the default configuration.
- If you want to serve your site
under a custom root domain, define `root_domain: true` to get correct links
between languages.
## Projects using it
- [mkdocs-mdpo-plugin][mkdocs-mdpo-plugin-link]
[mkdocs-material-ss-link]: https://squidfunk.github.io/mkdocs-material/setup/changing-the-language/#site-language-selector
[mkdocs-mdpo-plugin-link]: https://mondeja.github.io/mkdocs-mdpo-plugin/
[project-pypi-version-badge]: https://img.shields.io/pypi/v/mkdocs-material-relative-language-selector?label=version
[project-pypi-link]: https://pypi.org/project/mkdocs-material-relative-language-selector/
[project-downloads-badge]: https://img.shields.io/pypi/dm/mkdocs-material-relative-language-selector?style=flat-square
[project-downloads-link]: https://pypistats.org/packages/mkdocs-material-relative-language-selector