Skip to content

Commit 9edef3c

Browse files
authored
Merge pull request #219 from geopython/i18n-readme
add translation workflow to README
2 parents 4226d5b + 5314d48 commit 9edef3c

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

README.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,26 @@ mkdocs build
4343
mkdocs serve # website is made available on http://localhost:8000
4444
```
4545

46+
### Translating the workshop to a different language
47+
48+
The workshop is setup to support content in different languages, via the [mkdocs-static-i18n](https://pypi.org/project/mkdocs-static-i18n) plugin. To add an additional language to the workshop:
49+
50+
- in `mkdocs.yml`, section `plugins.i18n.languages`, add a section with at least the `locale`, `name`, and `build` directives. For example, to add Greek:
51+
52+
```yaml
53+
- locale: el
54+
name: Ελληνικά
55+
build: true
56+
```
57+
58+
- foreach `.md` page in `workshop/content/docs`, add an equivalant page in the language with the locale code as part of the filename. For example:
59+
- `ogcapi-records.md` -> `ogcapi-records.el.md`
60+
61+
- commit to your fork and issue a GitHub Pull Request
62+
63+
NOTE: see [issue 217](https://github.com/geopython/diving-into-pygeoapi/issues/217) to track the implementation of auto-translation.
64+
65+
4666
## Contributing updates
4767

4868
To make contributions back to the workshop, fork the repository from GitHub. Contributions and Pull Requests are always welcome!

0 commit comments

Comments
 (0)