Microsoft.DocAsCode.Dotnet 2.67.5

前缀已保留
.NET 6.0 此包针对 .NET 6.0 框架。该包与此框架兼容或更高版本。
建议的替代方案

Docfx.Dotnet

附加详情

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

dotnet add package Microsoft.DocAsCode.Dotnet --version 2.67.5                

                    
                

            
NuGet\Install-Package Microsoft.DocAsCode.Dotnet -Version 2.67.5
该命令旨在在 Visual Studio 的包管理器控制台中使用，因为它使用 NuGet 模块的 Install-Package 版本。
<PackageReference Include="Microsoft.DocAsCode.Dotnet" Version="2.67.5" />
对于支持 PackageReference 的项目，将此 XML 节点复制到项目文件中以引用包。
paket add Microsoft.DocAsCode.Dotnet --version 2.67.5                

                    
                

            
#r "nuget: Microsoft.DocAsCode.Dotnet, 2.67.5"
#r 指令可用于 F# Interactive 和 Polyglot Notebooks。将其复制到交互式工具或脚本的源代码中，以引用包。
// Install Microsoft.DocAsCode.Dotnet as a Cake Addin
#addin nuget:?package=Microsoft.DocAsCode.Dotnet&version=2.67.5

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

使用 docfx 构建您的文档

NuGet Help Wanted Gitter

使用 docfx，带上页、Markdown、.NET、REST API 以及更多构建您的技术文档网站。

⚠️⚠️⚠️ 注意⚠️⚠️⚠️

DocFX 正在过渡到 .NET 基金会，作为一个官方 .NET 项目！

  • DocFX 团队正在改进主分支。这将为项目引入新的功能和错误修复，删除一些不再必要的较旧代码和功能，以及更新依赖关系和简化项目结构。请关注路线图。
  • 由于网站架构变更，DocFX无法再直接支持构建Microsoft Learn内容。包含Microsoft Learn Markdown内容的开源仓库仍将接受pull请求和更改，但不能直接使用DocFX构建。
  • 未来，我们只将支持将该工具作为新网站的静态站点生成器，而不是用于在Microsoft Learn上构建官方Microsoft内容的工具。

入门指南

  1. 安装docfx作为全局工具

    dotnet tool install -g docfx

  2. 在本地创建并启动一个网站

    docfx init -q
docfx build docfx_project\docfx.json --serve

  3. 访问 https://127.0.0.1:8080 以查看示例网站。

有关更多信息，请参阅入门。

贡献

有关问题和一般讨论，请在讨论中使用。有关错误报告和功能建议，请在问题中使用。

我们欢迎通过pull请求提交代码贡献，标记为 help-wanted 的是开始贡献代码的好选择。

先决条件

构建和测试

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

分支和发布

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

发布基于一个稳定的main分支提交，使用GitHub Releases。鼓励使用常规提交。

Docfx不会按照常规节奏发布，新版本何时到来取决于维护者认为更改足够多，需要新的版本。有时我们会使用预发布版来尝试破坏性更改并从社区获得反馈。

路线图

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

  • 工作集正在积极开发的功能。不是这个桶中的每个功能都会在下一个版本中归档，但它们反映了维护者在未来一段时间内的首要任务。

  • 待办事项是一系列为一些未来的版本预留的功能候选人，但它们目前不是开发活动。

许可

该项目基于MIT许可证。

.NET 基金会

该项目由.NET Foundation支持。

该项目采用了由Contributor Covenant定义的行为准则，以阐明我们社区中预期的行为。有关更多信息，请参阅.NET Foundation行为准则。

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

展示依赖于 Microsoft.DocAsCode.Dotnet 的前两个 NuGet 包

包 下载
Microsoft.DocAsCode.Build.ManagedReference

包描述
Microsoft.DocAsCode.Build.MemberLevelManagedReference

包描述

GitHub 仓库

此包没有被任何流行的 GitHub 仓库使用。