Docfx.MarkdigEngine
2.78.2
Prefix Reserved
dotnet add package Docfx.MarkdigEngine --version 2.78.2
NuGet\Install-Package Docfx.MarkdigEngine -Version 2.78.2
<PackageReference Include="Docfx.MarkdigEngine" Version="2.78.2" />
paket add Docfx.MarkdigEngine --version 2.78.2
#r "nuget: Docfx.MarkdigEngine, 2.78.2"
// Install Docfx.MarkdigEngine as a Cake Addin #addin nuget:?package=Docfx.MarkdigEngine&version=2.78.2 // Install Docfx.MarkdigEngine as a Cake Tool #tool nuget:?package=Docfx.MarkdigEngine&version=2.78.2
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.
As you may have heard docfx has been transitioned to be a .NET Foundation project. Microsoft Learn no longer uses docfx and do not intend to support the project since Nov 2022.
Docfx is planned to continue as a community-driven project. We hope to produce future releases with new features and enhancements to support existing and new use cases. We also would like to invite any interested parties to be involved in this project. If you'd like to contact the community team please open a discussion thread.
Getting Started
Install docfx as a global tool:
dotnet tool install -g docfx
Create and start a website locally:
docfx init -y docfx build docfx_project\docfx.json --serve
Go to https://localhost:8080 to see the sample site.
For more information, refer to Getting Started.
[!TIP] Docfx publishes nightly builds to GitHub Packages, this allows you to stay up-to-date with the latest developments in Docfx.
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 SDK 8.x and 9.x.
- Install NodeJS (22.x.x).
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
- Run
dotnet build
to build the project or use Visual Studio to builddocfx.sln
. - Run
dotnet test
to test the project or use Visual Studio test explorer.- Run
git lfs checkout
to 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 occasionally 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 | 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. net9.0 is compatible. |
-
net8.0
- Docfx.Common (>= 2.78.2)
- Docfx.MarkdigEngine.Extensions (>= 2.78.2)
- Docfx.YamlSerialization (>= 2.78.2)
- Markdig (>= 0.38.0)
- Newtonsoft.Json (>= 13.0.3)
- System.Collections.Immutable (>= 9.0.0)
-
net9.0
- Docfx.Common (>= 2.78.2)
- Docfx.MarkdigEngine.Extensions (>= 2.78.2)
- Docfx.YamlSerialization (>= 2.78.2)
- Markdig (>= 0.38.0)
- Newtonsoft.Json (>= 13.0.3)
- System.Collections.Immutable (>= 9.0.0)
NuGet packages (2)
Showing the top 2 NuGet packages that depend on Docfx.MarkdigEngine:
Package | Downloads |
---|---|
Docfx.App
Docfx published as a library for extensibility and advanced customization |
|
Docfx.Build.SchemaDriven
Technical documentation tool with markdown, API docs for .NET, REST API and more. |
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
2.78.2 | 844 | 11/26/2024 |
2.78.1 | 474 | 11/19/2024 |
2.78.0 | 202 | 11/18/2024 |
2.77.0 | 7,383 | 7/1/2024 |
2.76.0 | 5,761 | 4/7/2024 |
2.75.3 | 3,730 | 2/18/2024 |
2.75.2 | 7,654 | 1/27/2024 |
2.75.1 | 5,186 | 1/13/2024 |
2.75.0 | 1,376 | 1/12/2024 |
2.74.1 | 1,238 | 11/30/2023 |
2.74.0 | 1,213 | 11/20/2023 |
2.73.2 | 1,727 | 11/13/2023 |
2.73.1 | 243 | 11/7/2023 |
2.73.0 | 292 | 11/2/2023 |
2.72.1 | 249 | 10/28/2023 |
2.72.0 | 311 | 10/24/2023 |
2.71.1 | 808 | 10/18/2023 |
2.71.0 | 504 | 9/30/2023 |
2.70.4 | 364 | 9/18/2023 |
2.70.3 | 262 | 9/5/2023 |
2.70.2 | 219 | 9/4/2023 |
2.70.1 | 427 | 9/4/2023 |
2.70.0 | 1,526 | 7/29/2023 |