HTML文档

SingulinkFX — HTML 文档模板

作者 Singulink

面向 .NET 库的 DocFX 响应式模板,风格贴近微软官方文档,支持深浅主题与四级目录。

看看你的网站会是什么样

浏览真实页面截图,比较内容排版与手机效果。点击下方缩略图切换,放大查看整页细节。

2 个预览视图
浅色文档1 / 2
作者提供的预览

查看浅色文档的内容组织、布局与视觉细节。

全部页面与视图 2

截图用于了解视觉与布局,交互效果请以实际项目为准。

采集于 2026-09-27查看来源

值得关注的模板亮点

从已有项目资料中,快速了解它的特点。

01

视觉风格贴近微软 .NET 官方文档,适合 .NET 库的 API 参考

02

支持四级目录,配合 separatePages 成员布局可拆分每个成员为独立页面

03

浅色/深色主题切换(v3.1 起),颜色与侧栏宽度可配置

04

自动移除空表格列,未写注释的参数或返回值不会显示空白列

05

内置 Bootstrap Icons,文章样式可选用 article 类激活

06

提供两个真实项目在线演示,便于预览效果

模板详细介绍

SingulinkFX 是 Singulink 团队为自家 .NET 项目维护的 DocFX 模板,目标很明确:让生成的 API 文档看起来像微软官方 .NET 文档。它完全响应式,默认配色和排版都贴近 docs.microsoft.com 的风格,适合希望文档观感专业、统一的 .NET 库作者。

模板的核心能力围绕 DocFX 的 API 文档场景展开。它支持四级目录,配合 DocFX 的 separatePages 成员布局,可以把每个方法、属性拆成独立页面,便于链接和导航。表格会自动隐藏空列,避免未写注释的方法留下空白描述列。v3.1 起加入浅色/深色主题切换,颜色、侧栏宽度、字体大小都可在 CSS 变量中调整,也内置了 Bootstrap Icons。文章页面有独立的样式覆盖,用 article 类包裹即可获得更适合阅读的排版。

使用门槛取决于你对 DocFX 的熟悉程度。如果你已经在用 DocFX,这个模板接入成本很低:下载模板、复制到 templates 目录、在 docfx.json 里加上模板名即可。若从零开始,建议参考 Singulink.IO.FileSystem 仓库里的 Docs 目录结构。注意模板版本与 DocFX 版本有对应关系,3.x 需要 DocFX v2.75+,旧版 DocFX 需用 v1.1。上线前请确认你的 DocFX 版本匹配,并检查自定义配置项是否生效。

HTML文档

适合你的项目吗?

适用场景

  • 为 .NET 库生成 API 参考文档,并希望观感接近微软官方文档
  • 已有 DocFX 项目,想换用更现代、响应式的模板
  • 需要将每个类型成员拆分为独立页面以便链接和导航
  • 希望文档支持浅色/深色主题切换,且能自定义品牌色

适合人群

  • .NET 库作者或开源项目维护者
  • 熟悉 DocFX 基本配置的开发者
  • 需要文章与 API 参考混合呈现的文档站点

上手与定制指南

结合仓库当前版本的说明,按下面的资料检查内容、配置与运行要求。

  1. 1

    需要 DocFX v2.75+(模板 3.x)。

  2. 2

    下载模板后复制到 DocFX 项目的 templates 目录,并在 docfx.json 的 template 数组中放在 default 之后。

  3. 3

    若需成员独立页面,需在 metadata 中设置 memberLayout 为 separatePages。

  4. 4

    自定义颜色和布局建议通过子主题覆盖 styles/main.css,而不是直接修改模板文件。

查看仓库使用说明

授权与来源资料

使用条件与限制

免费使用 · 保留许可声明

MIT许可证明确允许免费使用、修改、分发和商用,仅需保留版权与许可声明。

使用时需要遵守

  • 保留原作者版权声明和 MIT 许可证声明。
  • 在所有副本或实质性部分中包含版权声明和许可声明

额外费用与待核对事项

  • README中Attribution部分内容被截断,未能确认是否有额外署名要求
查看原文依据

Permission is hereby granted, free of charge, to any person obtaining a copy

许可证原文

The above copyright notice and this permission notice shall be included in all

许可证原文

## Attribution

README 原文

Permission is hereby granted, free of char

许可证原文
https://github.com/Singulink/SingulinkFX/blob/master/LICENSEhttps://github.com/Singulink/SingulinkFX/blob/HEAD/README.md

DeepSeek 根据仓库许可证和 README 整理 ·2026-09-24。结果仅覆盖已读取资料,依赖、图片、字体及后续条款变更以各自原文为准。

项目核对记录与介绍依据

模板资料

来源平台
GitHub
资料与维护参考分
资料一般 · 69 / 100
技术栈
HTML
网站类型
文档
这个分数如何计算

本站按许可资料(最高30分)、演示链接(12分)、预览图(10分)、Star数(15分)、记录的维护时间(15分)、描述完整度(8分)、功能记录(5分)和分类资料(5分)计算。它不是代码、安全或性能测试,也不是 Google 评分;有链接不代表已实测可用。

这个项目需要核对什么

记录的仓库更新时间
2026-05-21
截图检查日期
2026-09-03

目前没有记录演示链接。请依据仓库说明在本地评估;仅凭截图无法确认交互行为。

目录记录的主要技术栈是 HTML。请通过依赖清单和锁文件核对实际版本与托管要求。这些说明基于收录资料,不代表代码审计或部署实测。

查看具体选型方法 →

介绍的制作与核对状态

介绍由 AI 辅助整理目录与仓库资料。仓库作者不等于这篇介绍的审核者。

当前版本没有可核对的编辑审核记录;旧的应用时间不代表已完成事实审核。

这条历史介绍未保存固定版本的来源快照。请对照当前仓库,发现不一致可反馈。

反馈内容错误

看看同类模板

对比同技术栈与用途的模板,找到更适合的视觉与内容结构。