build: inherit config from base & use single file to pass variables

OpenXiangShan · Feb 24, 2025 · 5e7994b · 5e7994b
1 parent 2c688e0
commit 5e7994b
Show file tree

Hide file tree

Showing 5 changed files with 6 additions and 33 deletions.
diff --git a/Makefile b/Makefile
@@ -21,6 +21,7 @@ PANDOC_FLAGS += --metadata=include-auto
 PANDOC_FLAGS += --lua-filter=utils/pandoc_filters/replace_variables.lua
 PANDOC_FLAGS += --lua-filter=utils/pandoc_filters/remove_md_links.lua
 PANDOC_FLAGS += --filter pandoc-crossref
+PANDOC_FLAGS += --metadata-file=variables.yml
 
 PANDOC_LATEX_FLAGS += --top-level-division=chapter
 PANDOC_LATEX_FLAGS += --pdf-engine=xelatex

diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,34 +1,6 @@
-site_name: 香山开源处理器用户手册
-theme:
-  name: material
-  features:
-    - navigation.indexes
-
-extra_css:
-  - stylesheets/extra.css
-
-markdown_extensions:
-  - admonition
-  - pymdownx.details
-  - pymdownx.superfences
-  - footnotes
-  - abbr
-  - pymdownx.snippets
-  - attr_list
-  - md_in_html
-  - def_list
-  - markdown_grid_tables
-  - markdown_captions     # for image caption, use alt as caption
-  - table_captions:       # for table caption, use Table: xxxx
-      numbering: false
-  - remove_references
-  - remove_include
-  - replace_variables:
-      variables:
-        processor_name: "昆明湖 V2R2"
-
-plugins:
+INHERIT: utils/mkdocs-base.yml
 
+site_name: 香山开源处理器用户手册
 
 nav:
   - 前言: index.md

diff --git a/pandoc-main.md b/pandoc-main.md
@@ -8,8 +8,6 @@ title-line2: "用户手册"
 # title-line3: "User Guide"
 author: "香山团队·北京开源芯片研究院"
 date: "\\today"
-replace_variables:
-  processor_name: "昆明湖 V2R2"
 figureTitle: "图"
 tableTitle: "表"
 listingTitle: "代码"

diff --git a/utils b/utils
diff --git a/variables.yml b/variables.yml
@@ -0,0 +1,2 @@
+replace_variables:
+  processor_name: "昆明湖 V2R2"
+21 −2		mdx_extensions/replace_variables.py
+36 −0		mkdocs-base.yml
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		replace_variables:
		processor_name: "昆明湖 V2R2"