该项目使用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 >