Microsoft.DocAsCode.Build.SchemaDriven
2.67.5
Prefix Reserved
Docfx has been fully transitioned to be a .NET Foundation project entirely driven by the community for the interest of the community. Hence we are renaming the NuGet package names, assembly names and namespace names from Microsoft.DocAsCode.* to Docfx.*.
dotnet add package Microsoft.DocAsCode.Build.SchemaDriven --version 2.67.5
NuGet\Install-Package Microsoft.DocAsCode.Build.SchemaDriven -Version 2.67.5
<PackageReference Include="Microsoft.DocAsCode.Build.SchemaDriven" Version="2.67.5" />
paket add Microsoft.DocAsCode.Build.SchemaDriven --version 2.67.5
#r "nuget: Microsoft.DocAsCode.Build.SchemaDriven, 2.67.5"
// Install Microsoft.DocAsCode.Build.SchemaDriven as a Cake Addin #addin nuget:?package=Microsoft.DocAsCode.Build.SchemaDriven&version=2.67.5 // Install Microsoft.DocAsCode.Build.SchemaDriven as a Cake Tool #tool nuget:?package=Microsoft.DocAsCode.Build.SchemaDriven&version=2.67.5
Build your docs with docfx
Build your technical documentation site with docfx, with landing pages, markdown, API reference docs for .NET, REST API and more.
⚠️⚠️⚠️ NOTICE ⚠️⚠️⚠️
DocFX is being transitioned to the .NET Foundation as an official .NET project!
- The DocFX team is working on improving the main branch. This will introduce new features and bug fixes to the project, remove some older code and features that are no longer necessary, as well as update the dependencies and simplify the project structure. Stay tuned for a roadmap.
- Due to architectural changes in the site, DocFX can no longer support building Microsoft Learn content directly. The open source repos holding Markdown content for Microsoft Learn will still accept pull requests and changes, but are not directly buildable with DocFX.
- Moving forward, we will only be supporting this tool as a static site generator for new sites, not as a tool to build official Microsoft content on Microsoft Learn.
Getting Started
Install docfx as a global tool:
dotnet tool install -g docfxCreate and start a website locally:
docfx init -q docfx build docfx_project\docfx.json --serveGo to https://localhost:8080 to see the sample site.
For more information, refer to Getting Started.
Contributing
Use Discussions for questions and general discussions. Use Issues to report bugs and proposing features.
We welcome code contributions through pull requests, issues tagged as help-wanted are good candidate to start contributing code.
Prerequisites
- Install Visual Studio 2022 (Community or higher) and make sure you have the latest updates.
- Install .NET Core SDK 6.x and 7.x.
- Install NodeJS (16.x.x).
- Optional: Install wkhtmltopdf on Windows to test PDF using
choco install wkhtmltopdf.
Build and Test
- Build site templates in
templatesdirectory:- Run
npm installto restore npm dependencies. - Run
npm run buildto build the templates.
- Run
- Run
dotnet buildto build the project or use Visual Studio to builddocfx.sln. - Run
dotnet testto test the project or use Visual Studio test explorer.- Run
git lfs checkoutto checkout files for snapshot testing
- Run
Branch and Release
The main branch is the default branch for pull requests and most other development activities. We occationally use feature/* branches for epic feature development.
Releases are based on a stable main branch commit using GitHub Releases. Use of Conventional Commit is encouraged.
Docfx is not released under a regular cadence, new versions arrive when maintainers see enough changes that warrant a new releases. Sometimes we use prereleases to dogfood breaking changes and get feedbacks from the community.
Roadmap
We use Milestones to communicate upcoming changes docfx:
Working Set are features being actively worked on. Not every features in this bucket will be committed in the next release but they reflect top of minds of maintainers in the upcoming period.
Backlog is a set of feature candidates for some future releases, but are not being actively worked on.
License
This project is licensed under the MIT License.
.NET Foundation
This project is supported by the .NET Foundation.
This project has adopted the code of conduct defined by the Contributor Covenant to clarify expected behavior in our community. For more information see the .NET Foundation Code of Conduct.
| Product | Versions Compatible and additional computed target framework versions. |
|---|---|
| .NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net6.0
- JsonSchema.Net (>= 4.1.5)
- Markdig (>= 0.31.0)
- Microsoft.DocAsCode.Build.Common (>= 2.67.5)
- Microsoft.DocAsCode.Build.OverwriteDocuments (>= 2.67.5)
- Microsoft.DocAsCode.Common (>= 2.67.5)
- Microsoft.DocAsCode.DataContracts.Common (>= 2.67.5)
- Microsoft.DocAsCode.MarkdigEngine (>= 2.67.5)
- Microsoft.DocAsCode.Plugins (>= 2.67.5)
-
net7.0
- JsonSchema.Net (>= 4.1.5)
- Markdig (>= 0.31.0)
- Microsoft.DocAsCode.Build.Common (>= 2.67.5)
- Microsoft.DocAsCode.Build.OverwriteDocuments (>= 2.67.5)
- Microsoft.DocAsCode.Common (>= 2.67.5)
- Microsoft.DocAsCode.DataContracts.Common (>= 2.67.5)
- Microsoft.DocAsCode.MarkdigEngine (>= 2.67.5)
- Microsoft.DocAsCode.Plugins (>= 2.67.5)
-
net8.0
- JsonSchema.Net (>= 4.1.5)
- Markdig (>= 0.31.0)
- Microsoft.DocAsCode.Build.Common (>= 2.67.5)
- Microsoft.DocAsCode.Build.OverwriteDocuments (>= 2.67.5)
- Microsoft.DocAsCode.Common (>= 2.67.5)
- Microsoft.DocAsCode.DataContracts.Common (>= 2.67.5)
- Microsoft.DocAsCode.MarkdigEngine (>= 2.67.5)
- Microsoft.DocAsCode.Plugins (>= 2.67.5)
NuGet packages (2)
Showing the top 2 NuGet packages that depend on Microsoft.DocAsCode.Build.SchemaDriven:
| Package | Downloads |
|---|---|
|
Microsoft.DocAsCode.Build.Engine
Package Description |
|
|
Microsoft.DocAsCode.App
Docfx published as a library for extensibility and advanced customization |
GitHub repositories
This package is not used by any popular GitHub repositories.
| Version | Downloads | Last updated | |
|---|---|---|---|
| 2.67.5 | 9,402 | 6/21/2023 | |
| 2.67.3 | 1,658 | 6/2/2023 | |
| 2.67.2 | 498 | 5/26/2023 | |
| 2.67.1 | 540 | 5/16/2023 | |
| 2.67.0 | 937 | 5/6/2023 | |
| 2.66.2 | 4,962 | 4/26/2023 | |
| 2.66.1 | 1,526 | 4/25/2023 | |
| 2.66.0 | 476 | 4/24/2023 | |
| 2.65.3 | 523 | 4/14/2023 | |
| 2.65.2 | 495 | 4/11/2023 | |
| 2.65.1 | 439 | 4/9/2023 | |
| 2.65.0 | 479 | 4/7/2023 | |
| 2.64.0 | 613 | 3/30/2023 | |
| 2.63.1 | 759 | 3/21/2023 | |
| 2.63.0 | 520 | 3/20/2023 | |
| 2.62.2 | 549 | 3/7/2023 | |
| 2.62.1 | 1,980 | 2/15/2023 | |
| 2.62.0 | 485 | 2/14/2023 | |
| 2.61.0 | 2,455 | 1/30/2023 | |
| 2.60.2 | 965 | 1/20/2023 | |
| 2.60.1 | 609 | 1/18/2023 | |
| 2.60.0 | 1,072 | 1/13/2023 | |
| 2.60.0-preview.2 | 143 | 12/25/2022 | |
| 2.60.0-preview.1 | 137 | 12/20/2022 | |
| 2.59.4 | 6,861 | 9/7/2022 | |
| 2.59.3 | 1,109 | 7/6/2022 | |
| 2.59.2 | 1,114 | 4/11/2022 | |
| 2.59.1 | 826 | 3/31/2022 | |
| 2.59.0 | 3,581 | 1/19/2022 | |
| 2.58.9 | 926 | 11/4/2021 | |
| 2.58.8 | 558 | 11/1/2021 | |
| 2.58.5 | 576 | 10/26/2021 | |
| 2.58.4 | 667 | 9/14/2021 | |
| 2.58.3 | 566 | 9/7/2021 | |
| 2.58.2 | 609 | 8/24/2021 | |
| 2.58.1 | 588 | 8/23/2021 | |
| 2.58.0 | 829 | 6/9/2021 | |
| 2.57.2 | 691 | 4/14/2021 | |
| 2.57.1 | 601 | 4/13/2021 | |
| 2.57.0 | 599 | 4/9/2021 | |
| 2.56.7 | 1,715 | 3/2/2021 | |
| 2.56.6 | 1,477 | 12/10/2020 | |
| 2.56.5 | 737 | 11/10/2020 | |
| 2.56.4 | 2,725 | 10/20/2020 | |
| 2.56.3 | 709 | 10/12/2020 | |
| 2.56.2 | 935 | 7/27/2020 | |
| 2.56.1 | 845 | 7/6/2020 | |
| 2.56.0 | 854 | 6/29/2020 | |
| 2.55.0 | 1,020 | 6/12/2020 | |
| 2.53.1 | 896 | 5/11/2020 | |
| 2.52.0 | 1,024 | 4/13/2020 | |
| 2.51.0 | 2,940 | 3/20/2020 | |
| 2.50.0 | 1,042 | 3/2/2020 | |
| 2.49.0 | 905 | 2/17/2020 | |
| 2.48.1 | 2,548 | 1/13/2020 | |
| 2.48.0 | 1,623 | 12/9/2019 | |
| 2.47.0 | 1,227 | 10/31/2019 | |
| 2.46.0 | 1,351 | 10/14/2019 | |
| 2.45.1 | 3,045 | 9/15/2019 | |
| 2.45.0 | 1,113 | 8/25/2019 | |
| 2.44.0 | 1,827 | 8/2/2019 | |
| 2.43.2 | 1,935 | 7/2/2019 | |
| 2.43.1 | 1,069 | 6/14/2019 | |
| 2.42.4 | 1,914 | 5/24/2019 | |
| 2.42.3 | 13,318 | 5/13/2019 | |
| 2.42.2 | 922 | 5/10/2019 | |
| 2.42.0 | 1,026 | 4/22/2019 | |
| 2.41.0 | 3,030 | 3/29/2019 | |
| 2.40.12 | 958 | 3/11/2019 | |
| 2.40.11 | 2,101 | 2/16/2019 | |
| 2.40.10 | 1,094 | 2/1/2019 | |
| 2.40.9 | 1,154 | 1/31/2019 | |
| 2.40.8 | 1,169 | 1/25/2019 | |
| 2.40.7 | 1,049 | 1/4/2019 | |
| 2.40.5 | 1,103 | 12/19/2018 | |
| 2.40.4 | 1,052 | 11/26/2018 | |
| 2.40.2 | 1,062 | 11/7/2018 | |
| 2.40.1 | 1,056 | 10/29/2018 | |
| 2.40.0 | 1,107 | 10/12/2018 | |
| 2.39.2 | 2,629 | 9/9/2018 | |
| 2.39.1 | 2,483 | 9/4/2018 | |
| 2.39.0 | 5,610 | 9/2/2018 | |
| 2.38.1 | 5,730 | 8/16/2018 | |
| 2.38.0 | 1,329 | 8/13/2018 | |
| 2.37.2 | 1,171 | 7/31/2018 | |
| 2.37.1 | 1,465 | 7/31/2018 | |
| 2.36.2 | 1,461 | 6/13/2018 | |
| 2.36.1 | 1,325 | 5/25/2018 | |
| 2.36.0 | 1,360 | 5/21/2018 | |
| 2.36.0-alpha-0159-g25e5900b4 | 951 | 4/26/2018 | |
| 2.35.4 | 1,390 | 5/2/2018 | |
| 2.35.3 | 1,330 | 5/2/2018 | |
| 2.35.0-alpha-0153-g6da267dd4 | 947 | 4/25/2018 | |
| 2.33.2 | 1,658 | 4/3/2018 | |
| 2.33.1 | 1,298 | 4/3/2018 | |
| 2.33.0 | 1,280 | 3/19/2018 | |
| 2.32.2 | 1,293 | 3/12/2018 | |
| 2.32.0 | 1,319 | 2/28/2018 | |
| 2.31.0 | 1,367 | 2/5/2018 | |
| 2.30.0 | 1,449 | 1/12/2018 | |
| 2.29.1 | 1,462 | 12/29/2017 | |
| 2.28.3 | 1,278 | 12/14/2017 | |
| 2.28.2 | 1,344 | 12/7/2017 | |
| 2.28.1 | 1,298 | 12/1/2017 | |
| 2.28.0 | 1,268 | 11/30/2017 | |
| 2.27.0 | 1,282 | 11/21/2017 | |
| 2.26.3 | 1,356 | 10/26/2017 | |
| 2.26.1 | 1,250 | 10/24/2017 | |
| 2.26.0 | 1,237 | 10/23/2017 | |
| 2.25.1 | 1,223 | 10/9/2017 | |
| 2.25.0 | 1,426 | 10/9/2017 | |
| 2.24.0 | 1,327 | 9/11/2017 | |
| 2.23.1 | 1,287 | 8/22/2017 |