Docfx.Build.UniversalReference 2.77.0

前缀已预留
dotnet add package Docfx.Build.UniversalReference --version 2.77.0                
NuGet\Install-Package Docfx.Build.UniversalReference -Version 2.77.0                
此命令旨在在 Visual Studio 的包管理器控制台中使用,因为它使用了 NuGet 模块的 Install-Package 版本。
<PackageReference Include="Docfx.Build.UniversalReference" Version="2.77.0" />                
对于支持 包引用 的项目,将此 XML 节点复制到项目文件中以便引用此包。
paket add Docfx.Build.UniversalReference --version 2.77.0                
#r "nuget: Docfx.Build.UniversalReference, 2.77.0"                
#r 指令可用于 F# Interactive 和 Polyglot Notebooks。将此内容复制到交互式工具或脚本的源代码中以便引用此包。
// Install Docfx.Build.UniversalReference as a Cake Addin
#addin nuget:?package=Docfx.Build.UniversalReference&version=2.77.0

// Install Docfx.Build.UniversalReference as a Cake Tool
#tool nuget:?package=Docfx.Build.UniversalReference&version=2.77.0                

使用 docfx 构建文档

NuGet Help Wanted

使用 docfx 构建您的技术文档站点,包括首页、Markdown、.NET、REST API 等文档。


如您所知,docfx 已经过渡为 .NET 基金会项目。Microsoft Learn 不再使用 docfx,并且不打算从 2022 年 11 月开始支持此项目。

docfx 计划继续作为一个社区驱动的项目。我们希望产生带有新特性和增强功能的新版本,以支持现有和新用例。我们也希望邀请任何感兴趣的相关方参与此项目。如果您想联系社区团队,请打开一个讨论线程。

入门指南

  1. 将 docfx 安装为全局工具

    dotnet tool install -g docfx
    
  2. 在本地创建和启动网站

    docfx init -y
    docfx build docfx_project\docfx.json --serve
    
  3. 转到 https://127.0.0.1:8080 查看示例网站。

有关更多信息,请参阅 入门指南

提示:Docfx每晚都会将构建发布到GitHub Packages,这样您可以随时了解Docfx的最新进展。

贡献

对于问题和对文档的总体讨论,请使用讨论区。要报告错误和提出功能建议,请使用问题

我们欢迎通过Pull Request提供代码贡献。那些标记为help-wanted的问题是一道很好的开始,从这里可以开始贡献代码。

先决条件

构建和测试

  • templates目录中构建网站模板
    • 运行npm install以还原npm依赖项。
    • 运行npm run build以构建模板。
  • 运行dotnet build以构建项目或使用Visual Studio构建docfx.sln
  • 运行dotnet test以测试项目或使用Visual Studio测试资源管理器。
    • 运行git lfs checkout以检查用于快照测试的文件

分支和发布

main分支是默认的提交请求和大多数其他开发活动的分支。我们偶尔使用feature/*分支来进行史诗功能开发。

发布基于稳定的main分支的提交,使用GitHub发布。强烈推荐使用常规提交

Docfx不会定期发布,新版本会在维护者看到足够多的变更并认为需要新的发布时到达。有时我们使用预发布版来自我测试破坏性变更并从社区获取反馈。

路线图

我们使用里程碑来沟通即将到来的Docfx更改

  • 工作集正在积极开发的功能。这个桶中的并非每个功能都会在下一个版本中提交,但它们反映了维护者在即将到来的时期的主要关注点。

  • 待办事项是一组一些未来版本的功能候选者,但不是正在积极开发的功能。

许可

该项目受MIT许可授权。

.NET 基金会

该项目由.NET Foundation支持。

该项目已采用维护者公约中定义的行为准则以阐明我们社区的预期行为。有关更多信息,请参阅.NET Foundation行为准则

产品 兼容和额外计算的Target Framework版本。
.NET net6.0 兼容。 net6.0-android 已计算。 net6.0-ios 已计算。 net6.0-maccatalyst 已计算。 net6.0-macos 已计算。 net6.0-tvos 已计算。 net6.0-windows 已计算。 net7.0 已计算。 net7.0-android 已计算。 net7.0-ios 已计算。 net7.0-maccatalyst 已计算。 net7.0-macos 已计算。 net7.0-tvos 已计算。 net7.0-windows 已计算。 net8.0 兼容。 net8.0-android 已计算。 net8.0-browser 已计算。 net8.0-ios 已计算。 net8.0-maccatalyst 已计算。 net8.0-macos 已计算。 net8.0-tvos 已计算。 net8.0-windows 已计算。
兼容的目标框架
包含的目标框架(在包中)
了解有关 目标框架.NET Standard 的更多信息。

NuGet 包 (1)

显示对 Docfx.Build.UniversalReference 依赖的前 1 个 NuGet 包

下载
Docfx.App

Docfx 发布为库,以便进行扩展和高级定制

GitHub 仓库

此包未用于任何流行的 GitHub 仓库。

版本 下载 更新时间
2.77.0 906 7/1/2024
2.76.0 3,663 4/7/2024
2.75.3 2,648 2/18/2024
2.75.2 2,050 1/27/2024
2.75.1 3,015 1/13/2024
2.75.0 1,197 1/12/2024
2.74.1 1,073 11/30/2023
2.74.0 858 11/20/2023
2.73.2 1,368 11/13/2023
2.73.1 172 11/7/2023
2.73.0 214 11/2/2023
2.72.1 175 10/28/2023
2.72.0 249 10/24/2023
2.71.1 714 10/18/2023
2.71.0 425 9/30/2023
2.70.4 299 9/18/2023
2.70.3 190 9/5/2023
2.70.2 144 9/4/2023
2.70.1 343 9/4/2023
2.70.0 1,216 7/29/2023