feat: add meta information for HTML pages

MegEngine · Mar 31, 2022 · bb6d867 · bb6d867
1 parent d12c5c3
commit bb6d867
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 1 deletion.
diff --git a/source/_templates/indexcontent.html b/source/_templates/indexcontent.html
@@ -1,4 +1,11 @@
 {% extends "layout.html" %}
+{%- block extrahead -%}
+<meta content="天元 MegEngine 官方文档" lang="zh-Hans" name="description" xml:lang="zh-Hans" />
+<meta content="MegEngine official documentation" lang="en" name="description" xml:lang="en" />
+<meta content="天元, 深度学习, 深度学习框架, 文档, 教程, 参考, 开发, 旷视科技" lang="zh-Hans" name="keywords" xml:lang="zh-Hans" />
+<meta content="MegEngine, deep learning, deep learning framework, documentation, tutorial, reference, development, megvii" lang="en" name="keywords" xml:lang="en" />
+{%- endblock -%}
+
 {%- block htmltitle -%}
 <title>{{ shorttitle }}</title>
 {%- endblock -%}

diff --git a/source/development/index.rst b/source/development/index.rst
@@ -3,6 +3,11 @@
 ==========
 开发者指南
 ==========
+.. meta::
+   :description lang=zh-Hans: 天元 MegEngine 框架开发者的参考说明书。
+   :description lang=en: MegEngine developer reference manual.
+   :keywords lang=zh-Hans: 天元, 深度学习, 框架, 开发者, 参考, 手册, 说明书
+   :keywords lang=en: MegEngine, deep learning, framework, developer, reference, manual
 
 .. toctree::
    :maxdepth: 1

diff --git a/source/getting-started/index.rst b/source/getting-started/index.rst
@@ -3,6 +3,12 @@
 ========
 新手入门
 ========
+.. meta::
+   :description lang=zh-Hans: 天元 MegEngine 入门教程，适合不同水平、阶段的用户。
+   :description lang=en: MegEngine tutorials for users of all levels.
+   :keywords lang=zh-Hans: 天元, 教程, 课程, 新手入门, 快速上手, 学习, 深度学习
+   :keywords lang=en: MegEngine, deep learning, tutorial, beginner, quick start, learning, crash course
+
 .. toctree::
    :hidden:
 
@@ -45,4 +51,3 @@ MegEngine 可以使用 Python 包管理器 ``pip`` 直接进行安装：
    ^^^^^^^^^^^^^^^^^^^^^^
    如果你想要通过实践 MegEngine 的使用来加深对基础知识的理解，
    我们为你准备了一系列 :ref:`deep-learning` ，希望能有所帮助！
-
diff --git a/source/reference/index.rst b/source/reference/index.rst
@@ -3,6 +3,12 @@
 ========
 API 参考
 ========
+.. meta::
+   :description lang=zh-Hans: 天元 MegEngine API 定义与使用介绍，提供权威参考信息。
+   :description lang=en: MegEngine API manual and official reference.
+   :keywords lang=zh-Hans: 天元, 深度学习, 接口, 规格, 定义, 查询, 引用, 参考, 用例
+   :keywords lang=en: MegEngine, deep learning, interface, specification, define, reference, example
+
 :对应版本: |version|
 :更新时间: |today|
 

diff --git a/source/user-guide/index.rst b/source/user-guide/index.rst
@@ -3,6 +3,12 @@
 ========
 用户指南
 ========
+.. meta::
+   :description lang=zh-Hans: 天元 MegEngine 用户指南，能够引导用户在不同需求下完成相应的目标。
+   :description lang=en: MegEngine guides that help users accomplish the corresponding goals in different situations.
+   :keywords lang=zh-Hans: 天元, 深度学习, 指南, 用户指南, 使用手册, 案例, 示范, 如何完成
+   :keywords lang=en: MegEngine, deep learning, guide, user guide, how-to, example, step-by-step
+
 .. toctree::
    :hidden:
    :maxdepth: 1