Build your docs with DocFX

Build your docs website with DocFX, with landing pages, markdown documents, API references for .NET, REST and more.

We are still at an early develop phase, see our roadmap for detailed planing. Our current focus is conceptual document parity with https://learn.microsoft.com, template system is currently not available so the output is currently raw JSON files.

Getting Started

• Install .NET Core
• Install latest docfx pre release:

dotnet tool update -g docfx --version "3.0.0-*" --add-source https://docfx.pkgs.visualstudio.com/docfx/_packaging/docs-public-packages/nuget/v3/index.json

• Create a directory for your website:

mkdir my-website
cd my-website

• Create a new website:

docfx new conceptual

• Build your website.

docfx build

• Start a local HTTP static file server in _site folder. If you are using http-server:

http-server _site

Binary Builds

Release page

Contributing

If you are interested in proposing ideas and fixing issues, see How to Contribute.

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

Copyright (c) Microsoft Corporation. All rights reserved.

Licensed under the MIT License.

.NET Foundation

This project is supported by the .NET Foundation.