Microsoft.DocAsCode.Build.Engine 2.63.1

Prefix Reserved

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

Suggested Alternatives

Docfx.Build.Engine

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.Engine --version 2.63.1

NuGet\Install-Package Microsoft.DocAsCode.Build.Engine -Version 2.63.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.Engine" Version="2.63.1" />

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

paket add Microsoft.DocAsCode.Build.Engine --version 2.63.1

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

#r "nuget: Microsoft.DocAsCode.Build.Engine, 2.63.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.Engine as a Cake Addin
#addin nuget:?package=Microsoft.DocAsCode.Build.Engine&version=2.63.1

// Install Microsoft.DocAsCode.Build.Engine as a Cake Tool
#tool nuget:?package=Microsoft.DocAsCode.Build.Engine&version=2.63.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
.NET Foundation
License

Build your technical documentation site with docfx, with landing pages, markdown, API reference docs for .NET, REST API and more.

⚠️⚠️⚠️ NOTICE ⚠️⚠️⚠️

For Microsoft Learn users, the open source version of docfx will NOT be maintained to support Microsoft Learn content. For Microsoft Learn feature requests, bug reports and other support ticks, use internal channels such as the Learn Platform Support Channel.

V3 branch has been privatized to support Microsoft Learn, the development of V3 branch in the public is officially stopped.

Getting Started

Install docfx as a global tool:
```
dotnet tool install -g docfx
```

Create and start a website locally:

docfx init -q
docfx 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.

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

License

This project is licensed under the MIT License.

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
- Jint (>= 3.0.0-beta-2048)
- Microsoft.DocAsCode.Build.Common (>= 2.63.1)
- Microsoft.DocAsCode.Build.SchemaDriven (>= 2.63.1)
- Microsoft.DocAsCode.Common (>= 2.63.1)
- Microsoft.DocAsCode.DataContracts.Common (>= 2.63.1)
- Microsoft.DocAsCode.Dfm (>= 2.63.1)
- Microsoft.DocAsCode.Glob (>= 2.63.1)
- Microsoft.DocAsCode.MarkdownLite (>= 2.63.1)
- Microsoft.DocAsCode.Plugins (>= 2.63.1)
- Microsoft.DocAsCode.YamlSerialization (>= 2.63.1)
- Stubble.Core (>= 1.10.8)
net7.0
- Jint (>= 3.0.0-beta-2048)
- Microsoft.DocAsCode.Build.Common (>= 2.63.1)
- Microsoft.DocAsCode.Build.SchemaDriven (>= 2.63.1)
- Microsoft.DocAsCode.Common (>= 2.63.1)
- Microsoft.DocAsCode.DataContracts.Common (>= 2.63.1)
- Microsoft.DocAsCode.Dfm (>= 2.63.1)
- Microsoft.DocAsCode.Glob (>= 2.63.1)
- Microsoft.DocAsCode.MarkdownLite (>= 2.63.1)
- Microsoft.DocAsCode.Plugins (>= 2.63.1)
- Microsoft.DocAsCode.YamlSerialization (>= 2.63.1)
- Stubble.Core (>= 1.10.8)
net8.0
- Jint (>= 3.0.0-beta-2048)
- Microsoft.DocAsCode.Build.Common (>= 2.63.1)
- Microsoft.DocAsCode.Build.SchemaDriven (>= 2.63.1)
- Microsoft.DocAsCode.Common (>= 2.63.1)
- Microsoft.DocAsCode.DataContracts.Common (>= 2.63.1)
- Microsoft.DocAsCode.Dfm (>= 2.63.1)
- Microsoft.DocAsCode.Glob (>= 2.63.1)
- Microsoft.DocAsCode.MarkdownLite (>= 2.63.1)
- Microsoft.DocAsCode.Plugins (>= 2.63.1)
- Microsoft.DocAsCode.YamlSerialization (>= 2.63.1)
- Stubble.Core (>= 1.10.8)

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Microsoft.DocAsCode.Build.Engine:

Package	Downloads
Microsoft.DocAsCode.App Docfx published as a library for extensibility and advanced customization	40.6K

GitHub repositories

This package is not used by any popular GitHub repositories.

Version	Downloads	Last updated
2.67.5	9,102	6/21/2023
2.67.3	1,604	6/2/2023
2.67.2	456	5/26/2023
2.67.1	522	5/16/2023
2.67.0	871	5/6/2023
2.66.2	4,860	4/26/2023
2.66.1	1,496	4/25/2023
2.66.0	426	4/24/2023
2.65.3	483	4/14/2023
2.65.2	423	4/11/2023
2.65.1	342	4/9/2023
2.65.0	438	4/7/2023
2.64.0	553	3/30/2023
2.63.1	692	3/21/2023
2.63.0	444	3/20/2023
2.62.2	513	3/7/2023
2.62.1	1,915	2/15/2023
2.62.0	420	2/14/2023
2.61.0	2,390	1/30/2023
2.60.2	851	1/20/2023
2.60.1	506	1/18/2023
2.60.0	964	1/13/2023
2.60.0-preview.2	142	12/25/2022
2.60.0-preview.1	135	12/20/2022
2.59.4	6,785	9/7/2022
2.59.3	1,150	7/6/2022
2.59.2	1,102	4/11/2022
2.59.1	729	3/31/2022
2.59.0	3,475	1/19/2022
2.58.9	782	11/4/2021
2.58.8	571	11/1/2021
2.58.5	572	10/26/2021
2.58.4	615	9/14/2021
2.58.3	567	9/7/2021
2.58.2	588	8/24/2021
2.58.1	564	8/23/2021
2.58.0	774	6/9/2021
2.57.2	705	4/14/2021
2.57.1	587	4/13/2021
2.57.0	601	4/9/2021
2.56.7	1,740	3/2/2021
2.56.6	1,466	12/10/2020
2.56.5	740	11/10/2020
2.56.4	746	10/20/2020
2.56.3	724	10/12/2020
2.56.2	930	7/27/2020
2.56.1	796	7/6/2020
2.56.0	805	6/29/2020
2.55.0	907	6/12/2020
2.54.0	879	6/4/2020
2.53.1	992	5/11/2020
2.52.0	1,142	4/13/2020
2.51.0	3,104	3/20/2020
2.50.0	1,113	3/2/2020
2.49.0	959	2/17/2020
2.48.1	2,319	1/13/2020
2.48.0	1,797	12/9/2019
2.47.0	1,400	10/31/2019
2.46.0	1,520	10/14/2019
2.45.1	3,244	9/15/2019
2.45.0	1,345	8/25/2019
2.44.0	2,031	8/2/2019
2.43.2	2,230	7/2/2019
2.43.1	1,341	6/14/2019
2.42.4	2,106	5/24/2019
2.42.3	13,512	5/13/2019
2.42.2	1,146	5/10/2019
2.42.0	1,239	4/22/2019
2.41.0	3,269	3/29/2019
2.40.12	1,182	3/11/2019
2.40.11	2,414	2/16/2019
2.40.10	1,342	2/1/2019
2.40.9	1,432	1/31/2019
2.40.8	1,447	1/25/2019
2.40.7	1,306	1/4/2019
2.40.5	1,308	12/19/2018
2.40.4	1,280	11/26/2018
2.40.2	1,371	11/7/2018
2.40.1	1,324	10/29/2018
2.40.0	1,344	10/12/2018
2.39.2	2,860	9/9/2018
2.39.1	2,795	9/4/2018
2.39.0	5,869	9/2/2018
2.38.1	6,136	8/16/2018
2.38.0	1,544	8/13/2018
2.37.2	1,410	7/31/2018
2.37.1	1,710	7/31/2018
2.36.2	1,643	6/13/2018
2.36.1	1,558	5/25/2018
2.36.0	1,571	5/21/2018
2.36.0-alpha-0159-g25e5900b4	978	4/26/2018
2.35.4	1,530	5/2/2018
2.35.3	1,603	5/2/2018
2.35.0-alpha-0153-g6da267dd4	983	4/25/2018
2.33.2	1,903	4/3/2018
2.33.1	1,444	4/3/2018
2.33.0	1,464	3/19/2018
2.32.2	1,618	3/12/2018
2.32.0	1,494	2/28/2018
2.31.0	1,650	2/5/2018
2.30.0	1,713	1/12/2018
2.29.1	1,785	12/29/2017
2.28.3	1,473	12/14/2017
2.28.2	1,612	12/7/2017
2.28.1	1,604	12/1/2017
2.28.0	1,537	11/30/2017
2.27.0	1,522	11/21/2017
2.26.3	1,695	10/26/2017
2.26.1	1,531	10/24/2017
2.26.0	1,492	10/23/2017
2.25.1	1,503	10/9/2017
2.25.0	1,698	10/9/2017
2.24.0	1,591	9/11/2017
2.23.1	1,496	8/22/2017
2.22.3	1,483	8/17/2017
2.22.1	1,497	8/2/2017
2.22.0	1,520	8/1/2017
2.21.2	1,531	7/26/2017
2.21.1	1,636	7/17/2017
2.20.0	1,545	7/12/2017
2.19.2	1,687	6/29/2017
2.18.5	1,572	6/15/2017
2.18.4	1,596	6/9/2017
2.18.3	1,581	6/8/2017
2.18.1	1,514	5/31/2017
2.17.5	1,518	5/23/2017
2.17.3	1,573	5/11/2017
2.17.2	1,555	5/9/2017
2.16.8	1,772	5/3/2017
2.16.7	1,594	4/26/2017
2.16.5	1,546	4/25/2017
2.16.2	1,618	4/20/2017
2.16.0	1,535	4/17/2017
2.15.5	2,004	4/6/2017
2.15.2	1,983	3/29/2017
2.13.1	1,927	3/7/2017
2.13.0	2,038	3/6/2017
2.12.1	2,078	2/14/2017
2.12.0	1,981	2/13/2017
2.11.3	1,931	2/7/2017
2.11.2	1,859	1/25/2017
2.11.1	1,875	1/24/2017
2.11.0	1,917	1/23/2017
2.10.2	1,952	1/4/2017
2.10.1	2,150	1/4/2017
2.10.0	2,287	1/3/2017
2.9.3	1,944	12/15/2016
2.9.2	1,954	12/14/2016
2.9.1	1,985	12/13/2016
2.9.0	1,980	12/12/2016
2.8.2	1,987	11/28/2016
2.8.1	1,976	11/24/2016
2.8.0	2,106	11/22/2016
2.7.3	2,266	11/8/2016
2.7.2	2,164	11/3/2016
2.7.1	2,229	11/1/2016
2.7.0	1,966	10/31/2016
2.6.3	1,992	10/25/2016
2.6.1	1,924	10/11/2016
2.6.0	1,944	10/10/2016
2.5.4	2,487	9/22/2016
2.5.3	2,303	9/20/2016
2.5.2	2,141	9/19/2016
2.5.1	2,184	9/19/2016
2.5.0	1,933	9/14/2016
2.4.0	1,836	8/29/2016
2.3.1	1,742	8/22/2016
2.3.0	1,903	8/8/2016
2.2.2	1,914	7/22/2016
2.2.1	1,766	7/19/2016
2.2.0	1,811	7/18/2016
2.1.0	1,900	6/27/2016
2.0.2	1,792	6/22/2016
2.0.1	1,883	6/7/2016
2.0.0	1,803	6/6/2016
1.9.4	2,163	5/19/2016
1.9.3	1,849	5/19/2016
1.9.0	1,867	5/16/2016
1.8.4	1,849	5/10/2016
1.8.1	1,828	5/4/2016
1.8.0	2,000	4/25/2016
1.7.2	1,841	4/20/2016
1.7.1	1,837	4/7/2016
1.7.0	2,049	4/6/2016

Total 317.0K

Current version 692

Per day average 100