該項目使用node.js和Gulp作為構建工具,以加速IGNITE UI DOCFX樣品站點的IGNITE UI for Angular的開發。
要安裝DOCFX,請將其還原為dotnet工具 - 安裝.NET本地工具,該工具範圍為當前目錄:
dotnet tool restore注意:執行npm install還將恢復dotnet工具依賴項作為postinstall步驟。
如果您使用的是NPM,請運行:
npm install如果您使用的是紗線,請運行:
yarn install構建過程取決於環境變量NODE_ENV能夠為角樣本設置正確的URL。將development , staging或production分配給NODE_ENV 。
您可以通過分配環境創建一個.env文件,並設置NODE_ENV 。
NODE_ENV=development
要啟動服務器,請運行:
對於英語:
npm start -- --lang en對於Japansese:
npm start -- --lang jp對於韓語:
npm start -- --lang kr該命令採用一個準確的參數-lang [en | JP | KR]提供英語,日語或韓語版本。
對於英語:
npm run build -- --lang en對於日語:
npm run build -- --lang jp對於韓語:
npm run build -- --lang kr構建腳本在相應項目的根部生成一個名為_Site的文件夾。例如,對於英語,靜態網站居住在en/_site下;
構建命令與上述步驟非常相似。要構建用於分期的網站,請運行:
npm run build-staging --lang en用於分期的構建命令是:
npm run build-production --lang jp代碼視圖元素的顯式編輯屬性允許為指定的示例設置明確的實時編輯器,並支持“ CSB”和“ Stackblitz”作為值。
< code-view explicit-editor =" csb " ... > </ code-view > < code-view explicit-editor =" stackblitz " ... > </ code-view > 打開'[en | JP |特定語言版本的kr] 組件 toc.yml'文件。每個TOC主題都包含名稱和HREF的參數,以及可選標籤參數。從Igniteui-docfx-template的版本3.5.1開始,受支持的標籤包括“新,更新”,“預覽”和“ beta”。要添加所需的標籤,只需指定其名稱並將其值設置為true即可。
例子:
- name: Update guide
href: general/update-guide.md
updated: true
要在文檔網站上生成和顯示可折疊代碼片段,請按照以下步驟:
使用類“花哨的詳細信息”創建一個<div>部分。
在創建<div>部分中添加<summary>元素。
將代碼摘要標頭的摘要文本添加到<summary>元素中。
在創建<div>部分中添加<code>元素。
將代碼段添加到<code>元素中。
例子:
< div class =" fancy-details " >
< summary > Example of a successful response body: </ summary >
< code >
{
"id": "{123456}_repo",
"modified": "2023-02-03T14:07:34.0000000",
"created": "2023-02-03T14:07:34.0000000",
"name": "Marketing",
"user": {
"id": "{123456}_u ",
"name": "Teddy Mitkova"
},
"dashboardSections": [
{
"id": "{123456}_f",
"name": "May"
}
]
}
</ code >
</ div >