build: generate html version via pandoc (#10)

This patch add build script for building the html version of the
document via pandoc. The document formatting has not yet been finely
adjusted.

.github/workflows/build-pdf.yml → .github/workflows/build-pandoc.yml

@@ -1,4 +1,4 @@
-name: build PDF version of document
+name: build document with pandoc
 
 on:
   push:
@@ -26,8 +26,14 @@ jobs:
         run: |
           make
       
-      - name: Upload artifacts
+      - name: Upload built pdf
         uses: actions/upload-artifact@v4
         with:
-          name: xiangshan-user-guide
+          name: xiangshan-user-guide-pdf
           path: xiangshan-user-guide.pdf
+
+      - name: Upload built html
+        uses: actions/upload-artifact@v4
+        with:
+          name: xiangshan-user-guide-html
+          path: xiangshan-user-guide.html

Makefile

@@ -14,19 +14,21 @@ PANDOC_FLAGS += --variable=version:"$(VERSION)"
 PANDOC_FLAGS += --from=markdown+table_captions+multiline_tables+grid_tables+header_attributes-implicit_figures
 PANDOC_FLAGS += --table-of-contents
 PANDOC_FLAGS += --number-sections
-# PANDOC_FLAGS += --filter pandoc-crossref
 PANDOC_FLAGS += --lua-filter=include-files.lua
 PANDOC_FLAGS += --metadata=include-auto
 PANDOC_FLAGS += --lua-filter=resources/meta_vars.lua
 PANDOC_FLAGS += --lua-filter=resources/remove_md_links.lua
+PANDOC_FLAGS += --filter pandoc-crossref
 
 PANDOC_LATEX_FLAGS += --top-level-division=chapter
 PANDOC_LATEX_FLAGS += --pdf-engine=xelatex
 PANDOC_LATEX_FLAGS += --lua-filter=resources/svg_to_pdf.lua
 PANDOC_LATEX_FLAGS += --template=resources/template.tex
 
+PANDOC_HTML_FLAGS += --embed-resources
+PANDOC_HTML_FLAGS += --shift-heading-level-by=1
 
-all: xiangshan-user-guide.pdf
+all: xiangshan-user-guide.pdf xiangshan-user-guide.html
 
 clean:
 	rm -f xiangshan-user-guide.tex xiangshan-user-guide.pdf *.aux *.log *.toc
@@ -40,6 +42,9 @@ xiangshan-user-guide.tex: $(MAIN_MD) $(SRCS) $(DEPS)
 	pandoc $(MAIN_MD) $(PANDOC_FLAGS) $(PANDOC_LATEX_FLAGS) -s -o $@
 	sed -i 's/@{}//g' $@
 
+xiangshan-user-guide.html: $(MAIN_MD) $(SRCS) $(DEPS) $(SVG_FIGS)
+	pandoc -s $(MAIN_MD) $(PANDOC_FLAGS) $(PANDOC_HTML_FLAGS) -o $@
+
 xiangshan-user-guide.pdf: xiangshan-user-guide.tex $(PDF_FIGS)
 	xelatex $^
 	xelatex $^