cc2968c2e9
* docs: 更新文档 对不起我忘记拆分 commit 了 优化 winget 安装运行库命令 添加 一键修复运行库.ps1 将 image 文件夹重命名为 images 添加账号切换执行时机说明 土下座 Co-authored-by: SherkeyXD <57581480+SherkeyXD@users.noreply.github.com> * docs: 跟上学姐的脚步 * fix: cli docs --------- Co-authored-by: SherkeyXD <57581480+SherkeyXD@users.noreply.github.com>
3.3 KiB
order, icon
| order | icon |
|---|---|
| 6 | jam:write-f |
文件編寫指南
::: tip 本文件的目的在於指導文件編寫者更好地使用主題提供的功能，以達到更易讀的效果。 :::
我們的文件基於 vuepress 構建，使用了 vuepress-theme-hope 主題，你也可以查看官方文件來獲取更詳細的說明，這裡僅介紹一些常用的功能。
本地部署
- 安裝 pnpm，並參考 Pull Request 流程簡述將倉庫克隆到本地。
- 在
website目錄下新建終端，運行pnpm i下載依賴。 - 運行
pnpm run dev進行部署。
容器
不是 docker 那個容器
該主題提供了關於提示、注釋、信息、注意、警告和詳情自定義容器的支持，我們可以利用這一特性來強調部分內容。
容器的使用方法：
::: [容器類型] [容器標題（可選）]
你想寫的內容
:::
接受的容器内容与其默认标题如下：
tip提示note注釋info信息warning注意danger警告details詳情
容器示例
::: tip 這是提示容器 :::
::: note 這是注釋容器 :::
::: info 這是信息容器 :::
::: warning 這是注意容器 :::
::: danger 這是危險容器 :::
::: details 這是詳情容器 :::
圖標
該主題提供了圖標支持，你可以在以下地方使用圖標：
-
文件標題：在 frontmatter 中設置文件標題旁邊的圖標
-
導航欄/側邊欄：設置在導航欄與側邊欄中顯示的圖標
-
文件內容：在文件中使用圖標
設置文件的圖標
你可以在文件的 frontmatter 中使用 icon 來設置文件的圖標。
这个图标会显示在文档标题的旁边。
::: details 本文件的 frontmatter 設置
---
icon: jam:write-f
---
:::
在文件中使用圖標
你可以使用 <HopeIcon /> 組件在 markdown 中添加圖標。該組件有以下屬性：
icon接受圖標關鍵字及 Url，如jam:write-f，ic:round-home等color接受 css 風格的顏色值，如#fff，red等（該選項僅對 svg 圖標有效）size接受 css 風格的大小，如1rem，2em，100px等
::: details 案例
<HopeIcon icon="ic:round-home" color="#1f1e33"/>
圖標關鍵字的獲取
本文件使用的圖標來自於 iconify，你可以在其給出的 圖標搜索界面 中搜索你想要的圖標，然後復制其關鍵字。
Frontmatter
Frontmatter 是 Markdown 文件開頭一段用 --- 包裹起來的內容，其內部使用 yml 語法。通過 Frontmatter，我們可以標識文件的編輯時間，使用的圖標，分類，標籤等等。
::: details 示例
---
date: 1919-08-10
icon: jam:write-f
order: 1
---
# 文件標題
...
:::
各字段含義如下：
date文件的編輯時間icon文件標題旁邊的圖標order文件在側邊欄中的排序