Config updates for website migration compatibility. (#57)

kattni · freakboy3742 · web-flow · commit e40f641f3ed1 · 2026-02-26T13:13:50.000+08:00
Co-authored-by: Russell Keith-Magee &lt;russell@keith-magee.com&gt;
diff --git a/docs/config.yml b/docs/config.yml
@@ -47,6 +47,7 @@ extra:
     - icon: fontawesome/brands/discord
       link: https://beeware.org/bee/chat/
       name: BeeWare on Discord
+  generator: false
 
 theme:
   name: material
@@ -58,6 +59,8 @@ theme:
     - toc.follow
     - navigation.indexes
     - navigation.footer
+    - navigation.tabs
+    - navigation.tabs.sticky
     - search.suggest
     - search.highlight
     - search.share
@@ -84,20 +87,58 @@ theme:
         name: Switch to system preference
 
 markdown_extensions:
+  # PyMdown Extensions
   pymdownx.highlight: {}
   pymdownx.superfences: {}
-  pymdownx.blocks.admonition: {}
   pymdownx.blocks.caption: {}
+  pymdownx.blocks.admonition:  # Enables admonitions.
+    types:
+      - note
+      - abstract
+      - info
+      - tip
+      - success
+      - question
+      - warning
+      - failure
+      - danger
+      - bug
+      - example
+      - quote
+  pymdownx.blocks.details:  # Enables collapsible content.
+    types:
+      - {name: details-note, class: note}
+      - {name: details-abstract, class: abstract}
+      - {name: details-info, class: info}
+      - {name: details-tip, class: tip}
+      - {name: details-success, class: success}
+      - {name: details-question, class: question}
+      - {name: details-warning, class: warning}
+      - {name: details-failure, class: failure}
+      - {name: details-danger, class: danger}
+      - {name: details-bug, class: bug}
+      - {name: details-example, class: example}
+      - {name: details-quote, class: quote}
   pymdownx.blocks.tab:
     alternate_style: true
+  pymdownx.magiclink:  # Among other things, enables GitHub shorthand references.
+    provider: "github"
+    user: "beeware"
+    repo: "toga"
+    repo_url_shortener: true
+    repo_url_shorthand: true
+    normalize_issue_symbols: true
   pymdownx.snippets:
     base_path: ["docs"]
     url_download: true
     check_paths: true
+  # Python Markdown Extensions
+  attr_list: {}
+  smarty:  # Enables easy em and en dashes.
+    smart_quotes: false
   toc:
     permalink: true
     title: On this page
-  attr_list: {}
 
 plugins:
   search: {}
diff --git a/docs/mkdocs.de.yml b/docs/mkdocs.de.yml
@@ -8,3 +8,11 @@ theme:
 
 extra:
   translation_type: machine
+  language_url: de/
+  header:
+    About: Über
+    Documentation: Dokumentation
+    Community: Verbund
+    Contributing: Mithelfen
+    News: Neuigkeiten
+    Sponsor: Fördern
diff --git a/docs/mkdocs.en.yml b/docs/mkdocs.en.yml
@@ -5,3 +5,4 @@ docs_dir: en
 
 extra:
   translation_type: original
+  header: {}
diff --git a/docs/mkdocs.es.yml b/docs/mkdocs.es.yml
@@ -8,3 +8,11 @@ theme:
 
 extra:
   translation_type: machine
+  language_url: es/
+  header:
+    About: Acerca
+    Documentation: Documentación
+    Community: Comunidad
+    Contributing: Contribuir
+    News: Noticias
+    Sponsor: Auspiciar
diff --git a/docs/mkdocs.fr.yml b/docs/mkdocs.fr.yml
@@ -8,3 +8,11 @@ theme:
 
 extra:
   translation_type: machine
+  language_url: fr/
+  header:
+    About: À Propos
+    Documentation: Documentation
+    Community: Communauté
+    Contributing: Contribuer
+    News: Nouvelles
+    Sponsor: Parrainer
diff --git a/docs/mkdocs.it.yml b/docs/mkdocs.it.yml
@@ -8,3 +8,11 @@ theme:
 
 extra:
   translation_type: machine
+  language_url: it/
+  header:
+    About: Circa
+    Documentation: Documentazione
+    Community: Comunità
+    Contributing: Contribuire
+    News: Notizie
+    Sponsor: Sponsorizzare
diff --git a/docs/mkdocs.pt.yml b/docs/mkdocs.pt.yml
@@ -8,3 +8,11 @@ theme:
 
 extra:
   translation_type: machine
+  language_url: pt/
+  header:
+    About: Sobre
+    Documentation: Documentação
+    Community: Comunidade
+    Contributing: Contribuir
+    News: News
+    Sponsor: Patrocinar
diff --git a/docs/mkdocs.zh_CN.yml b/docs/mkdocs.zh_CN.yml
@@ -1,10 +1,18 @@
 INHERIT: config.yml
 site_name: BeeWare Tutorial
-site_url: https://tutorial.beeware.org/zh_CN
+site_url: https://tutorial.beeware.org/zh-cn
 docs_dir: zh_CN
 
 theme:
   language: zh
 
 extra:
   translation_type: machine
+  language_url: zh-cn/
+  header:
+    About: 关于
+    Documentation: 文档
+    Community: 社区
+    Contributing: 贡献
+    News: 新闻
+    Sponsor: 赞助
diff --git a/docs/mkdocs.zh_TW.yml b/docs/mkdocs.zh_TW.yml
@@ -1,10 +1,18 @@
 INHERIT: config.yml
 site_name: BeeWare Tutorial
-site_url: https://tutorial.beeware.org/zh_TW
+site_url: https://tutorial.beeware.org/zh-tw
 docs_dir: zh_TW
 
 theme:
   language: zh-TW
 
 extra:
   translation_type: machine
+  language_url: zh-tw/
+  header:
+    About: 關於
+    Documentation: 文件
+    Community: 社群
+    Contributing: 貢獻
+    News: 新聞
+    Sponsor:  贊助
diff --git a/pyproject.toml b/pyproject.toml
@@ -33,7 +33,6 @@ exclude = ["CODE_OF_CONDUCT.md"]
 respect-gitignore = true
 
 # Disable rules:
-# MD013: Enforces line length
 # MD014: Forces commands in codeblocks to show output
 disable = ["MD014",]
 
diff --git a/tox.ini b/tox.ini
@@ -18,7 +18,7 @@ commands:
     translate : update_machine_translations --soft-fail de es fr it pt zh_CN zh_TW
     lint : markdown-checker --dir {[docs]docs_dir} --func check_broken_urls
     lint : pyspelling
-    live : live_serve_en {posargs}
+    live : live_serve_en {posargs} --port=8041
     all : build_md_translations {posargs} en de es fr it pt zh_CN zh_TW
     en : build_md_translations {posargs} en
     de : build_md_translations {posargs} de

Original file line number	Diff line number	Diff line change
`@@ -5,3 +5,4 @@ docs_dir: en`
`5`	`5`
`6`	`6`	`extra:`
`7`	`7`	`translation_type: original`
	`8`	`+ header: {}`