Commit 2e531cc3 authored by Jorge Tardío Rubio's avatar Jorge Tardío Rubio
Browse files

Multilingual folder structure

parent 3c4f5147
Pipeline #2549 failed with stages
in 35 seconds
site
public
\ No newline at end of file
......@@ -11,7 +11,9 @@ build_mkdocs:
script:
- export ENABLE_PANDOC_EXPORT=1
- mkdir data
- mkdocs build --verbose --site-dir data --no-directory-urls
- mkdir data/en/
- mkdocs build -f config/en/mkdocs.yml --verbose --site-dir data/en/ --no-directory-urls
- mkdocs build -f config/es/mkdocs.yml --verbose --site-dir data/es/ --no-directory-urls
artifacts:
paths:
- data
......@@ -22,7 +24,8 @@ pages:
only:
- main
script:
- mkdocs build --verbose --site-dir public --no-directory-urls
- mkdocs build -f config/en/mkdocs.yml --verbose --site-dir public/en/ --no-directory-urls
- mkdocs build -f config/es/mkdocs.yml --verbose --site-dir public/es/ --no-directory-urls
artifacts:
paths:
- public
......
......@@ -38,17 +38,17 @@ docker run --rm -it -v ${PWD}:/data jtr0/latex-pandoc /bin/bash -c 'cp -r /data
### Pdf
| Title page | Content |
| :----: | :----: |
| ![Title page of PDF](docs/imgs/eisvogel_title_page.png) | ![Content page of PDF](docs/imgs/eisvogel_content.png) |
| ![Title page of PDF](../../../../overrides/assets/images/index/index/eisvogel_title_page.png) | ![Content page of PDF](overrides/assets/images/eisvogel_content.png) |
| Images | Chapther One |
| :----: | :----: |
|![Images](docs/imgs/eisvogel_images.png) |![Chapther One](docs/imgs/eisvogel_chapter1.png) |
|![Images](overrides/assets/images/eisvogel_images.png) |![Chapther One](overrides/assets/images/eisvogel_chapter1.png) |
Download artifacts of pdfs: [https://lab.gsi.upm.es/docs/mkdocs-material/-/jobs/artifacts/main/download?job=generate_pdfs](https://lab.gsi.upm.es/docs/mkdocs-material/-/jobs/artifacts/main/download?job=generate_pdfs)
### Web page
![Material for Mkdocs](docs/imgs/web_page.png)
![Material for Mkdocs](overrides/assets/images/web_page.png)
Accesible on: [https://docs.gsi.upm.es/docs/mkdocs-material/](https://docs.gsi.upm.es/docs/mkdocs-material/)
......
site_name: Nombre Docs
site_name: Docs Name
site_description: Description...
repo_url: https://lab.gsi.upm.es/docs/mkdocs-material
docs_dir: '../../docs/en' # Where to find the English markdown files
site_dir: '../../public/en' # Where to put the English HTML files
repo_url: https://lab.gsi.upm.es/docs/mkdocs-material/
edit_uri: edit/main/docs/
nav:
- Material for MkDocs: index.md
- Bienvenido a MkDocs: index.md
- Ejemplo de collapse:
- Ejemplo1: toc1.md
- Ejemoplo2: toc2.md
- Material for MkDocs template: index.md
- Welcome to MkDocs: mkdocs.md
- Collapse example:
- Example1: toc1.md
- Example2: toc2.md
theme:
name: material
language: es
language: en
custom_dir: '../../overrides/' # This is where the customization of the theme lives
logo: assets/images/logo.svg # The logo is shared by all languages
favicon: assets/images/favicon.ico # The favicon is shared by all languages
include_search_page: true
search_index_only: true
palette:
# Light mode
- media: "(prefers-color-scheme: light)"
scheme: default
......@@ -26,7 +31,6 @@ theme:
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
# Dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
......@@ -35,6 +39,8 @@ theme:
toggle:
icon: material/toggle-switch
name: Switch to light mode
# features:
# - toc.integrate
plugins:
......@@ -48,20 +54,26 @@ plugins:
enabled_if_env: ENABLE_PANDOC_EXPORT
combined: true
combined_output_path: docs.pdf
- git-revision-date:
enabled_if_env: CI
- git-revision-date-localized:
timezone: Europe/Madrid
locale: en
fallback_to_build_date: false
enable_creation_date: true
# exclude:
# - index.md
markdown_extensions:
- toc:
permalink: "#"
toc_depth: 3
- attr_list
- pymdownx.tasklist:
custom_checkbox: true
extra:
social:
- icon: fontawesome/brands/gitlab
link: https://lab.gsi.upm.es/devops-templates/mkdocs-material
link: https://lab.gsi.upm.es/docs/mkdocs-material
- icon: fontawesome/brands/gitter
link: https://gitter.im/repo
- icon: fontawesome/brands/docker
......@@ -69,10 +81,9 @@ extra:
- icon: fontawesome/brands/twitter
link: https://twitter.com/devops
alternate:
- link: /
- link: /docs/mkdocs-material/
name: en - English
lang: en
- link: /es/
- link: /docs/mkdocs-material/es/
name: es - español
lang: es
\ No newline at end of file
lang: es
\ No newline at end of file
site_name: Docs Name
site_description: Description...
docs_dir: '../../docs/es' # Where to find the English markdown files
site_dir: '../../public/es' # Where to put the English HTML files
repo_url: https://lab.gsi.upm.es/docs/mkdocs-material/
edit_uri: edit/main/docs/
nav:
- Plantilla Material for MkDocs: index.md
- Welcome to MkDocs: mkdocs.md
- Collapse example:
- Example1: toc1.md
- Example2: toc2.md
theme:
name: material
language: en
custom_dir: '../../overrides/' # This is where the customization of the theme lives
logo: assets/images/logo.svg # The logo is shared by all languages
favicon: assets/images/favicon.ico # The favicon is shared by all languages
include_search_page: true
search_index_only: true
palette:
# Light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
accent: indigo
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
# Dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: blue
accent: blue
toggle:
icon: material/toggle-switch
name: Switch to light mode
# features:
# - toc.integrate
plugins:
- search
- minify:
minify_html: true
minify_js: true
htmlmin_opts:
remove_comments: true
- pandoc:
enabled_if_env: ENABLE_PANDOC_EXPORT
combined: true
combined_output_path: docs.pdf
- git-revision-date-localized:
timezone: Europe/Madrid
locale: en
fallback_to_build_date: false
enable_creation_date: true
# exclude:
# - index.md
markdown_extensions:
- toc:
permalink: "#"
toc_depth: 3
- attr_list
- pymdownx.tasklist:
custom_checkbox: true
extra:
social:
- icon: fontawesome/brands/gitlab
link: https://lab.gsi.upm.es/docs/mkdocs-material
- icon: fontawesome/brands/gitter
link: https://gitter.im/repo
- icon: fontawesome/brands/docker
link: https://hub.docker.com/r/jtr0
- icon: fontawesome/brands/twitter
link: https://twitter.com/devops
alternate:
- link: /docs/mkdocs-material/
name: en - English
lang: en
- link: /docs/mkdocs-material/es/
name: es - español
lang: es
\ No newline at end of file
......@@ -37,17 +37,17 @@ docker run --rm -it -v ${PWD}:/data jtr0/latex-pandoc /bin/bash -c 'cp -r /data
| Title page | Content |
| :----: | :----: |
| ![Title page of PDF](imgs/eisvogel_title_page.png){width=300px} | ![Content page of PDF](imgs/eisvogel_content.png){width=300px} |
| ![Title page of PDF](assets/images/index/eisvogel_title_page.png){width=300px} | ![Content page of PDF](assets/images/index/eisvogel_content.png){width=300px} |
| Images | Chapther One |
| :----: | :----: |
|![Images](imgs/eisvogel_images.png){width=300px} |![Chapther One](imgs/eisvogel_chapter1.png){width=300px} |
|![Images](assets/images/index/eisvogel_images.png){width=300px} |![Chapther One](assets/images/index/eisvogel_chapter1.png){width=300px} |
Download artifacts of pdfs: [https://lab.gsi.upm.es/docs/mkdocs-material/-/jobs/artifacts/main/download?job=generate_pdfs](https://lab.gsi.upm.es/docs/mkdocs-material/-/jobs/artifacts/main/download?job=generate_pdfs)
### Web page
![Material for Mkdocs](imgs/web_page.png)
![Material for Mkdocs](assets/images/index/web_page.png)
Accesible on: [https://docs.gsi.upm.es/docs/mkdocs-material](https://docs.gsi.upm.es/docs/mkdocs-material/)
......
# Bienvenido a Mkdocs
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment