diff options
| author | Bertrand Yuan <me@bertyuan.com> | 2026-04-27 20:52:54 +0800 |
|---|---|---|
| committer | Bertrand Yuan <me@bertyuan.com> | 2026-04-27 20:53:14 +0800 |
| commit | dbb5e791f0c228369605d126dd590962ebe1eddc (patch) | |
| tree | 8c83fc84bd9547630e6733929dec77e102e055a8 /Documentation/source/_templates | |
| parent | 658798b3a2378bb6df16cfbb16d707c6fb719e1e (diff) | |
docs: add comprehensive documentation for operations
This commit introduces a complete set of documentation files
covering various aspects of the project, including environment
setup, quality checks, command references, and architecture.
The documentation is structured to assist developers and
contributors in understanding the project's configuration,
workflow, and best practices.
Additionally, translations for Simplified and Traditional
Chinese have been added to ensure accessibility for a wider
audience. This enhances the overall usability and
maintainability of the project.
Signed-off-by: Bertrand Yuan <github@bertyuan.com>
Diffstat (limited to 'Documentation/source/_templates')
| -rw-r--r-- | Documentation/source/_templates/layout.html | 106 |
1 files changed, 106 insertions, 0 deletions
diff --git a/Documentation/source/_templates/layout.html b/Documentation/source/_templates/layout.html new file mode 100644 index 0000000..1f5ee78 --- /dev/null +++ b/Documentation/source/_templates/layout.html @@ -0,0 +1,106 @@ +{% extends "!layout.html" %} + +{% macro language_href(lang, section) -%} + {%- if lang == "en" -%} + {%- if section == "index" -%}{{ pathto('index') }} + {%- elif section == "introduction" -%}{{ pathto('introduction') }} + {%- elif section == "getting-started" -%}{{ pathto('getting-started') }} + {%- elif section == "architecture" -%}{{ pathto('architecture/index') }} + {%- elif section == "frontend" -%}{{ pathto('frontend/index') }} + {%- elif section == "operations" -%}{{ pathto('operations/index') }} + {%- elif section == "contributing" -%}{{ pathto('contributing/index') }} + {%- elif section == "reference" -%}{{ pathto('reference/index') }} + {%- endif -%} + {%- elif lang == "zh_CN" -%} + {%- if section == "index" -%}{{ pathto('zh_CN/index') }} + {%- else -%}{{ pathto('zh_CN/' ~ section) }} + {%- endif -%} + {%- elif lang == "zh_TW" -%} + {%- if section == "index" -%}{{ pathto('zh_TW/index') }} + {%- else -%}{{ pathto('zh_TW/' ~ section) }} + {%- endif -%} + {%- elif lang == "ja" -%} + {%- if section == "index" -%}{{ pathto('ja/index') }} + {%- else -%}{{ pathto('ja/' ~ section) }} + {%- endif -%} + {%- endif -%} +{%- endmacro %} + +{% macro language_selection() %} + {% if pagename.startswith("zh_CN/") %} + {% set current_language = "简体中文" %} + {% set normalized = pagename[6:] %} + {% elif pagename.startswith("zh_TW/") %} + {% set current_language = "繁體中文" %} + {% set normalized = pagename[6:] %} + {% elif pagename.startswith("ja/") %} + {% set current_language = "日本語" %} + {% set normalized = pagename[3:] %} + {% else %} + {% set current_language = "English" %} + {% set normalized = pagename %} + {% endif %} + + {% if normalized == "index" %} + {% set section = "index" %} + {% elif normalized == "introduction" %} + {% set section = "introduction" %} + {% elif normalized == "getting-started" %} + {% set section = "getting-started" %} + {% elif normalized.startswith("architecture") %} + {% set section = "architecture" %} + {% elif normalized.startswith("frontend") %} + {% set section = "frontend" %} + {% elif normalized.startswith("operations") %} + {% set section = "operations" %} + {% elif normalized.startswith("contributing") %} + {% set section = "contributing" %} + {% elif normalized.startswith("reference") %} + {% set section = "reference" %} + {% else %} + {% set section = "index" %} + {% endif %} + + <div class="language-selection" tabindex="0" aria-label="Select language"> + {{ current_language }} + <ul> + <li><a href="{{ language_href('en', section)|e }}">English</a></li> + <li><a href="{{ language_href('zh_CN', section)|e }}">简体中文</a></li> + <li><a href="{{ language_href('zh_TW', section)|e }}">繁體中文</a></li> + <li><a href="{{ language_href('ja', section)|e }}">日本語</a></li> + </ul> + </div> +{% endmacro %} + +{% block document %} + <div class="documentwrapper"> + {%- if render_sidebar %} + <div class="bodywrapper"> + {%- endif %} + + {%- block relbar_top %} + {%- if theme_show_relbar_top|tobool %} + <div class="related top"> + + </div> + {%- endif %} + {% endblock %} + + <div class="body" role="main"> + {{ language_selection() }} + {% block body %} {% endblock %} + </div> + + {%- block relbar_bottom %} + {%- if theme_show_relbar_bottom|tobool %} + <div class="related bottom"> + + </div> + {%- endif %} + {% endblock %} + + {%- if render_sidebar %} + </div> + {%- endif %} + </div> +{% endblock %} |
