Skip to content

DF-IT-Document/Document-Template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Document-Template

本專案是{{ Lorem ipsum dolor }}。

使用 Markdown 來撰寫。

文件位置

文件的檔案位於 src 資料夾

而整份文件的目錄則位於 SUMMARY.md

整個專案採用 mdbook 的架構來撰寫,關於 mdbook 的說明可參閱mdbook官方說明非官方的中文翻譯版

將文件轉為 HTML 網站

手動編譯

請先取得 mdbook(可以在其專案releases 中找到已編譯好的執行檔 )

然後到本專案的資料夾,執行 mdbook build 即可。

完整的指令如下:

C:\> cd {{專案資料夾}}
C:\{{專案資料夾}}> mdbook build

By Github Actions

本專案已經有撰寫好 github action

自動編譯

文件每次更新都會自動編譯。

首先進去 Actions > Build book to html files

Actions

Build book to html files

選擇最新一次執行任務。

最新一次執行任務

任務執行完成後,Artifacts會有編譯好的 HTML 網站打包成 .zip 壓縮檔。

alt text

手動執行 github action

一樣進去 Actions > Build book to html files

然後選擇 Run workflow 🔻 按鈕,選擇Run workflow即可

About

文件模板

Topics

Resources

Stars

Watchers

Forks

Contributors 2

  •  
  •