在应用中添加必要的参数
参数:
- tags:用于分类文档,如技术标签和应用标签。
- main:控制文档的结构,如标题或目录。
- content:填充文档内容,如代码块或解释。
- comp:生成代码片段或代码块。
- code:用于生成代码块。
- description:生成文档的简介。
- notes:附加信息,如作者或背景。
配置步骤:
- 在文档生成界面中,添加上述参数。
- 确保标签的值正确,例如在技术文档中添加技术术语和概念。
设置标签的值和优先级
参数:
- tags:设置标签的值,如“技术标签1”、“应用标签1”。
- main:默认值为“main”,生成标题或目录。
- content:填充具体内容,如“代码块内容”。
- comp:默认生成代码片段,如“代码块开始”和“代码块结束”。
- code:用于代码块内容。
定义文档生成规则
参数:
- template:自定义文档结构。
- comp:生成代码片段,定义结构。
- code:生成代码块内容。
运行文档生成工具
步骤:
- 确保配置正确。
- 运行文档生成工具,生成文档。
检查和调整生成结果
步骤:
- 查看生成文档,确认结构和内容是否符合预期。
- 根据需求调整参数和标签值。
示例配置
示例文档生成:
应用配置:
{
"tags": ["技术标签1", "技术标签2", "应用标签1", "应用标签2"],
"main": "main",
"content": "技术标签1和技术标签2的内容。",
"comp": {
"code": "代码块内容:\n代码块开始\n代码块内容\n代码块结束"
},
"description": "技术文档生成工具。",
"notes": "生成文档的作者和时间信息。"
}
文档生成: 使用 sing-box 的文档生成工具,按照上述配置生成文档。
注意事项
- 重复标签:确保标签优先级正确,避免混淆。
- 默认值:设置默认值,如“main”生成标题,或“comp”生成代码片段。
- 格式设置:调整格式,如分节或列表,根据文档类型设置。
通过以上步骤,可以系统地配置 sing-box,生成高质量的技术文档。









