Docfx.Dotnet 2.77.0

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

// Install Docfx.Dotnet as a Cake Tool
#tool nuget:?package=Docfx.Dotnet&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://localhost:8080 以查看示例网站。

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

[!提示] Docfx 每晚都会将构建版本发布到 GitHub Packages,这允许您随时了解 Docfx 的最新进展。

贡献

如有问题或进行一般讨论,请使用 讨论。如需报告错误或提议新功能,请使用 问题

我们欢迎通过拉取请求提交代码贡献。被标记为 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 Releases。鼓励使用 常规提交

Docfx 并非按照常规的节奏发布,当维护者看到足够多的变化足以引起新版本发布时,新版本才会出现。有时我们会使用预发布版本以尝鲜破坏性更改,并从社区中获得反馈。

路线图

我们使用 里程碑 传达 Docfx 的即将到来的更改。

  • 工作集 正在积极开发的特性。并非所有这些桶中的特性都将在下一个版本中提交,但它们反映了维护者在接下来的时间段内的主要关注点。

  • 待办事项 是未来某个版本的特性候选集,但目前并未积极开发。

许可协议

本项目受 MIT 许可证的许可。

.NET 基金会

本项目由 .NET 基金会 支持。

本项目采用了贡献者公约中定义的行为准则,以明确我们社区中期望的行为。有关更多信息,请参阅 .NET 基金会行为准则

产品 兼容和额外的计算目标框架版本。
.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.Dotnet 的顶级 1 个 NuGet 包

下载
Docfx.Build.ManagedReference

带 markdown 的技术文档工具,.NET API 文档,REST API 等。

GitHub 仓库

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

版本 下载 最后更新
2.77.0 978 7/1/2024
2.76.0 3,943 4/7/2024
2.75.3 2,649 2/18/2024
2.75.2 5,019 1/27/2024
2.75.1 3,066 1/13/2024
2.75.0 1,229 1/12/2024
2.74.1 1,155 11/30/2023
2.74.0 866 11/20/2023
2.73.2 1,394 11/13/2023
2.73.1 194 11/7/2023
2.73.0 527 11/2/2023
2.72.1 198 10/28/2023
2.72.0 259 10/24/2023
2.71.1 750 10/18/2023
2.71.0 445 9/30/2023
2.70.4 287 9/18/2023
2.70.3 282 9/5/2023
2.70.2 178 9/4/2023
2.70.1 354 9/4/2023
2.70.0 1,292 7/29/2023