Microsoft.DocAsCode.App 2.67.5

前缀已保留
建议的替代方案

Docfx.App

其他详细信息

Docfx 已完全过渡为完全由社区推动的 .NET 基金会项目,以利于社区。因此,我们正在将 NuGet 包名称、程序集名称和命名空间名称从 Microsoft.DocAsCode.* 更改为 Docfx.*。

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

// Install Microsoft.DocAsCode.App as a Cake Tool
#tool nuget:?package=Microsoft.DocAsCode.App&version=2.67.5                

使用 docfx 构建文档

NuGet Help Wanted Gitter

使用 docfx 构建技术文档网站,其中包含主页、markdown、.NET、REST API 等文档引用。

⚠️⚠️⚠️ 注意事项 ⚠️⚠️⚠️

DocFX 正在过渡到 .NET 基金会,成为官方 .NET 项目!

  • DocFX 团队正在改进主分支。这将向项目引入新功能和错误修复,删除一些不再必要的旧代码和功能,以及更新依赖项和简化项目结构。敬请关注路线图。
  • 由于网站架构变更,DocFX 无法再直接支持构建Microsoft Learn内容。持有Microsoft Learn Markdown内容的开源存储库将继续接受合并请求和更改,但无法直接使用DocFX构建。
  • 从现在起,我们只支持此工具作为新网站的静态网站生成器,而不是作为构建Microsoft Learn上官方Microsoft内容的工具。

入门

  1. 将docfx安装为全局工具

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

    docfx init -q
    docfx build docfx_project\docfx.json --serve
    
  3. 前往https://localhost:8080查看示例网站。

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

贡献

使用讨论区提问和进行一般讨论。使用问题报告错误和提出功能建议。

我们欢迎通过拉取请求进行代码贡献。标记为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 Foundation支持。

本项目采用由贡献者守则定义的规则,以阐明我们社区中预期的行为。有关更多信息,请参阅.NET Foundation Code of Conduct

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

该包未由任何NuGet包使用。

GitHub仓库

该包未由任何流行GitHub仓库使用。

版本 下载 最后更新
2.67.5 10,113 6/21/2023 2.67.5已弃用,因为它不再维护。
2.67.3 2,200 6/2/2023 2.67.3已弃用,因为它不再维护。
2.67.2 540 5/26/2023 2.67.2已弃用,因为它不再维护。
2.67.1 606 5/16/2023 2.67.1已弃用,因为它不再维护。
2.67.0 1,098 5/6/2023 2.67.0已弃用,因为它不再维护。
2.66.2 5,575 4/26/2023 2.66.2已弃用,因为它不再维护。
2.66.1 499 4/25/2023 2.66.1已弃用,因为它不再维护。
2.66.0 542 4/24/2023 2.66.0已弃用,因为它不再维护。
2.65.3 647 4/14/2023 2.65.3已弃用,因为它不再维护。
2.65.2 482 4/11/2023 2.65.2已弃用,因为它不再维护。
2.65.1 404 4/9/2023 2.65.1已弃用,因为它不再维护。
2.65.0 591 4/7/2023 2.65.0已弃用,因为它不再维护。
2.64.0 636 3/30/2023 2.64.0已弃用,因为它不再维护。
2.63.1 833 3/21/2023 2.63.1 已弃用,因为不再维护。
2.63.0 401 3/20/2023 2.63.0 已弃用,因为不再维护。
2.62.2 365 3/7/2023 2.62.2 已弃用,因为不再维护。
2.62.1 1,762 2/15/2023 2.62.1 已弃用,因为不再维护。
2.62.0 264 2/14/2023 2.62.0 已弃用,因为不再维护。
2.61.0 2,231 1/30/2023 2.61.0 已弃用,因为不再维护。
2.60.2 717 1/20/2023 2.60.2 已弃用,因为不再维护。
2.60.1 349 1/18/2023 2.60.1 已弃用,因为不再维护。
2.60.0 7,765 1/13/2023 2.60.0 已弃用,因为不再维护。
2.60.0-preview.2 120 12/25/2022 2.60.0-preview.2 已弃用,因为不再维护。