Microsoft.DocAsCode.Build.Common 2.67.1

Prefix Reserved

This package has been deprecated as it is legacy and is no longer maintained.

Suggested Alternatives

Docfx.Build.Common

Additional Details

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.*.

There is a newer version of this package available.
See the version list below for details.

dotnet add package Microsoft.DocAsCode.Build.Common --version 2.67.1

NuGet\Install-Package Microsoft.DocAsCode.Build.Common -Version 2.67.1

This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.

<PackageReference Include="Microsoft.DocAsCode.Build.Common" Version="2.67.1" />

For projects that support PackageReference, copy this XML node into the project file to reference the package.

paket add Microsoft.DocAsCode.Build.Common --version 2.67.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

#r "nuget: Microsoft.DocAsCode.Build.Common, 2.67.1"

#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.

// Install Microsoft.DocAsCode.Build.Common as a Cake Addin
#addin nuget:?package=Microsoft.DocAsCode.Build.Common&version=2.67.1

// Install Microsoft.DocAsCode.Build.Common as a Cake Tool
#tool nuget:?package=Microsoft.DocAsCode.Build.Common&version=2.67.1

The NuGet Team does not provide support for this client. Please contact its maintainers for support.

Build your docs with docfx

Getting Started
Contributing
Roadmap
License
.NET Foundation

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 docfx
```

Create and start a website locally:

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

Go 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 templates directory:
- Run npm install to restore npm dependencies.
- Run npm run build to build the templates.
Run dotnet build to build the project or use Visual Studio to build docfx.sln.
Run dotnet test to test the project or use Visual Studio test explorer.
- Run git lfs checkout to checkout files for snapshot testing

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	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.

Product

.NET

Compatible target framework(s)

Included target framework(s) (in package)

Learn more about Target Frameworks and .NET Standard.

net6.0
- HtmlAgilityPack (>= 1.11.46)
- Microsoft.DocAsCode.Common (>= 2.67.1)
- Microsoft.DocAsCode.DataContracts.Common (>= 2.67.1)
- Microsoft.DocAsCode.Plugins (>= 2.67.1)
- Microsoft.DocAsCode.YamlSerialization (>= 2.67.1)
- System.Composition (>= 7.0.0)
net7.0
- HtmlAgilityPack (>= 1.11.46)
- Microsoft.DocAsCode.Common (>= 2.67.1)
- Microsoft.DocAsCode.DataContracts.Common (>= 2.67.1)
- Microsoft.DocAsCode.Plugins (>= 2.67.1)
- Microsoft.DocAsCode.YamlSerialization (>= 2.67.1)
- System.Composition (>= 7.0.0)
net8.0
- HtmlAgilityPack (>= 1.11.46)
- Microsoft.DocAsCode.Common (>= 2.67.1)
- Microsoft.DocAsCode.DataContracts.Common (>= 2.67.1)
- Microsoft.DocAsCode.Plugins (>= 2.67.1)
- Microsoft.DocAsCode.YamlSerialization (>= 2.67.1)
- System.Composition (>= 7.0.0)

NuGet packages (17)

Showing the top 5 NuGet packages that depend on Microsoft.DocAsCode.Build.Common:

Package	Downloads
Microsoft.DocAsCode.Build.TableOfContents Package Description	368.7K
Microsoft.DocAsCode.Build.Engine Package Description	317.7K
Microsoft.DocAsCode.Build.ConceptualDocuments Package Description	283.8K
Microsoft.DocAsCode.Build.ManagedReference Package Description	281.9K
Microsoft.DocAsCode.Build.RestApi Package Description	262.4K

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last updated
2.67.5	10,260	6/21/2023
2.67.3	2,228	6/2/2023
2.67.2	1,055	5/26/2023
2.67.1	1,190	5/16/2023
2.67.0	1,638	5/6/2023
2.66.2	5,740	4/26/2023
2.66.1	2,303	4/25/2023
2.66.0	1,239	4/24/2023
2.65.3	1,404	4/14/2023
2.65.2	1,266	4/11/2023
2.65.1	1,217	4/9/2023
2.65.0	1,252	4/7/2023
2.64.0	5,871	3/30/2023
2.63.1	2,031	3/21/2023
2.63.0	1,402	3/20/2023
2.62.2	1,598	3/7/2023
2.62.1	3,073	2/15/2023
2.62.0	1,595	2/14/2023
2.61.0	3,702	1/30/2023
2.60.2	2,458	1/20/2023
2.60.1	1,809	1/18/2023
2.60.0	2,341	1/13/2023
2.60.0-preview.2	143	12/25/2022
2.60.0-preview.1	147	12/20/2022
2.59.4	14,025	9/7/2022
2.59.3	3,039	7/6/2022
2.59.2	6,357	4/11/2022
2.59.1	2,555	3/31/2022
2.59.0	4,337	1/19/2022
2.58.9	1,410	11/4/2021
2.58.8	1,014	11/1/2021
2.58.5	1,076	10/26/2021
2.58.4	4,441	9/14/2021
2.58.3	1,036	9/7/2021
2.58.2	1,312	8/24/2021
2.58.1	1,087	8/23/2021
2.58.0	2,158	6/9/2021
2.57.2	1,590	4/14/2021
2.57.1	1,064	4/13/2021
2.57.0	1,138	4/9/2021
2.56.7	3,907	3/2/2021
2.56.6	2,019	12/10/2020
2.56.5	1,662	11/10/2020
2.56.4	3,487	10/20/2020
2.56.3	1,376	10/12/2020
2.56.2	1,691	7/27/2020
2.56.1	1,398	7/6/2020
2.56.0	1,388	6/29/2020
2.55.0	1,581	6/12/2020
2.53.1	1,693	5/11/2020
2.52.0	1,949	4/13/2020
2.51.0	3,676	3/20/2020
2.50.0	1,678	3/2/2020
2.49.0	1,552	2/17/2020
2.48.1	4,157	1/13/2020
2.48.0	24,310	12/9/2019
2.47.0	1,918	10/31/2019
2.46.0	1,993	10/14/2019
2.45.1	3,739	9/15/2019
2.45.0	1,802	8/25/2019
2.44.0	2,491	8/2/2019
2.43.2	2,850	7/2/2019
2.43.1	1,329	6/14/2019
2.42.4	2,142	5/24/2019
2.42.3	14,127	5/13/2019
2.42.2	1,093	5/10/2019
2.42.0	13,310	4/22/2019
2.41.0	3,300	3/29/2019
2.40.12	1,505	3/11/2019
2.40.11	2,559	2/16/2019
2.40.10	1,316	2/1/2019
2.40.9	1,315	1/31/2019
2.40.8	1,345	1/25/2019
2.40.7	1,317	1/4/2019
2.40.5	1,355	12/19/2018
2.40.4	1,282	11/26/2018
2.40.2	1,369	11/7/2018
2.40.1	1,277	10/29/2018
2.40.0	1,373	10/12/2018
2.39.2	2,839	9/9/2018
2.39.1	2,699	9/4/2018
2.39.0	3,911	9/2/2018
2.38.1	6,151	8/16/2018
2.38.0	1,549	8/13/2018
2.37.2	1,446	7/31/2018
2.37.1	1,697	7/31/2018
2.36.2	1,723	6/13/2018
2.36.1	1,505	5/25/2018
2.36.0	1,634	5/21/2018
2.36.0-alpha-0159-g25e5900b4	996	4/26/2018
2.35.4	1,633	5/2/2018
2.35.3	1,629	5/2/2018
2.35.0-alpha-0153-g6da267dd4	944	4/25/2018
2.33.2	2,270	4/3/2018
2.33.1	1,531	4/3/2018
2.33.0	1,601	3/19/2018
2.32.2	1,663	3/12/2018
2.32.0	1,492	2/28/2018
2.31.0	1,487	2/5/2018
2.30.0	1,622	1/12/2018
2.29.1	1,967	12/29/2017
2.28.3	1,495	12/14/2017
2.28.2	1,590	12/7/2017
2.28.1	1,544	12/1/2017
2.28.0	1,505	11/30/2017
2.27.0	1,620	11/21/2017
2.26.3	1,653	10/26/2017
2.26.1	1,497	10/24/2017
2.26.0	1,465	10/23/2017
2.25.1	1,445	10/9/2017
2.25.0	1,675	10/9/2017
2.24.0	1,601	9/11/2017
2.23.1	1,521	8/22/2017
2.22.3	1,493	8/17/2017
2.22.1	1,659	8/2/2017
2.22.0	1,533	8/1/2017
2.21.2	1,528	7/26/2017
2.21.1	1,637	7/17/2017
2.20.0	1,592	7/12/2017
2.19.2	1,576	6/29/2017
2.18.5	1,576	6/15/2017
2.18.4	1,499	6/9/2017
2.18.3	1,562	6/8/2017
2.18.1	1,308	5/31/2017
2.17.5	1,349	5/23/2017
2.17.3	1,353	5/11/2017
2.17.2	1,351	5/9/2017
2.16.8	1,510	5/3/2017
2.16.7	1,341	4/26/2017
2.16.5	1,363	4/25/2017
2.16.2	1,372	4/20/2017
2.16.0	1,372	4/17/2017
2.15.5	2,990	4/6/2017
2.15.2	3,132	3/29/2017
2.13.1	2,928	3/7/2017
2.13.0	3,041	3/6/2017
2.12.1	2,955	2/14/2017
2.12.0	2,794	2/13/2017
2.11.3	2,941	2/7/2017
2.11.2	2,671	1/25/2017
2.11.1	2,672	1/24/2017
2.11.0	2,812	1/23/2017
2.10.2	2,641	1/4/2017
2.10.1	2,642	1/4/2017
2.10.0	2,884	1/3/2017
2.9.3	2,516	12/15/2016
2.9.2	2,498	12/14/2016
2.9.1	2,568	12/13/2016
2.9.0	2,538	12/12/2016
2.8.2	2,585	11/28/2016
2.8.1	2,666	11/24/2016
2.8.0	2,751	11/22/2016
2.7.3	2,887	11/8/2016
2.7.2	2,852	11/3/2016
2.7.1	2,868	11/1/2016
2.7.0	2,642	10/31/2016
2.6.3	2,554	10/25/2016
2.6.1	2,573	10/11/2016
2.6.0	2,671	10/10/2016
2.5.4	3,016	9/22/2016
2.5.3	2,863	9/20/2016
2.5.2	2,782	9/19/2016
2.5.1	2,798	9/19/2016
2.5.0	2,592	9/14/2016
2.4.0	1,861	8/29/2016
2.3.1	1,651	8/22/2016
2.3.0	1,800	8/8/2016
2.2.2	1,744	7/22/2016
2.2.1	1,734	7/19/2016
2.2.0	1,692	7/18/2016
2.1.0	1,850	6/27/2016
2.0.2	1,874	6/22/2016
2.0.1	1,911	6/7/2016
2.0.0	1,849	6/6/2016
1.9.4	2,036	5/19/2016
1.9.3	1,820	5/19/2016
1.9.0	1,875	5/16/2016
1.8.4	1,804	5/10/2016
1.8.1	1,807	5/4/2016
1.8.0	2,021	4/25/2016
1.7.2	1,813	4/20/2016
1.7.1	1,847	4/7/2016
1.7.0	2,052	4/6/2016

Total 442.2K

Current version 1.2K

Per day average 139