Docfx.DataContracts.UniversalReference 2.77.0
前缀已保留
dotnet add package Docfx.DataContracts.UniversalReference --version 2.77.0
NuGet\Install-Package Docfx.DataContracts.UniversalReference -Version 2.77.0
<PackageReference Include="Docfx.DataContracts.UniversalReference" Version="2.77.0" />
paket add Docfx.DataContracts.UniversalReference --version 2.77.0
#r "nuget: Docfx.DataContracts.UniversalReference, 2.77.0"
// Install Docfx.DataContracts.UniversalReference as a Cake Addin #addin nuget:?package=Docfx.DataContracts.UniversalReference&version=2.77.0 // Install Docfx.DataContracts.UniversalReference as a Cake Tool #tool nuget:?package=Docfx.DataContracts.UniversalReference&version=2.77.0
使用 docfx 构建您的文档
使用 docfx 构建您的技术文档网站,具有首页、Markdown、.NET、REST API 等文档。
如您所知,docfx 已转换为 .NET Foundation 项目。Microsoft Learn 从 2022 年 11 月起不再使用 docfx,也不打算支持该项目。
docfx 计划作为社区驱动的项目继续进行。我们希望产生未来版本,以新的功能和改进来支持现有和新用例。我们还想邀请任何感兴趣的相关方参与此项目。如果您想联系社区团队,请打开一个讨论线程。
入门
将 docfx 安装为全局工具
dotnet tool install -g docfx
创建并启动本地网站
docfx init -y docfx build docfx_project\docfx.json --serve
转到 https://127.0.0.1:8080 以查看示例网站。
获取更多信息,请参阅入门教程。
[!TIP] Docfx 每晚将构建版本发布到GitHub Packages,这使您可以随时了解 Docfx 的最新发展。
贡献
如有疑问或进行一般讨论,请使用讨论区。如需报告错误或提议新功能,请使用问题跟踪。
我们欢迎通过pull request提交代码贡献。标记为help-wanted
的标签下的issue是入门贡献代码的好选择。
先决条件
- 安装Visual Studio 2022(社区版或更高版本),并确保您拥有最新的更新。
- 安装.NET SDK的6.x和8.x版本。
- 安装NodeJS的20.x.x版本。
构建和测试
- 在
templates
目录下构建网站模板- 运行
npm install
以恢复npm依赖项。 - 运行
npm run build
来构建模板。
- 运行
- 运行
dotnet build
来构建项目或使用Visual Studio构建docfx.sln
。 - 运行
dotnet test
来测试项目或使用Visual Studio测试资源管理器。- 运行
git lfs checkout
以检出用于快照测试的文件
- 运行
分支和发布
main
分支是pull request和其他大多数开发活动的默认分支。对于史诗规模的功能开发,我们偶尔使用feature/*
分支。
发布基于稳定版本的控制台上提交的main
分支,使用GitHub Releases。鼓励使用conventional commits。
Docfx不会按照常规节奏发布,新版本将在维护者认为更改足够多、需要新的发布时发布。有时我们会使用预发布版来尝试重 breaking 变更并从社区获取反馈。
路线图
我们使用里程碑来传达即将对docfx进行的功能变更。
许可
本项目采用MIT协议授权。
.NET 基金会
本项目由.NET Foundation支持。
本项目采用了由贡献者公约定义的行为规范,以明确我们社区中期望的行为。有关更多信息,请参阅.NET Foundation行为规范。
产品 | 版本 兼容和额外的目标框架版本。 |
---|---|
.NET |
-
net6.0
-
net8.0
NuGet 包 (1)
显示依赖于 Docfx.DataContracts.UniversalReference 的前 1 个 NuGet 包
包 | 下载 |
---|---|
具有 markdown、.NET、REST API 等 API 文档的技术文档工具。 |
GitHub 仓库
没有流行的 GitHub 仓库使用此包。
版本 | 下载 | 最后更新 |
---|---|---|
2.77.0 | 979 | 7/1/2024 |
2.76.0 | 3,723 | 4/7/2024 |
2.75.3 | 2,700 | 2/18/2024 |
2.75.2 | 2,057 | 1/27/2024 |
2.75.1 | 3,053 | 1/13/2024 |
2.75.0 | 1,216 | 1/12/2024 |
2.74.1 | 1,062 | 11/30/2023 |
2.74.0 | 862 | 11/20/2023 |
2.73.2 | 1,352 | 11/13/2023 |
2.73.1 | 175 | 11/7/2023 |
2.73.0 | 222 | 11/2/2023 |
2.72.1 | 170 | 10/28/2023 |
2.72.0 | 247 | 10/24/2023 |
2.71.1 | 740 | 10/18/2023 |
2.71.0 | 429 | 9/30/2023 |
2.70.4 | 298 | 9/18/2023 |
2.70.3 | 250 | 9/5/2023 |
2.70.2 | 148 | 9/4/2023 |
2.70.1 | 352 | 9/4/2023 |
2.70.0 | 1,216 | 7/29/2023 |