Docfx

Static site generator for .NET API documentation.
Alternatives To Docfx
Project NameStarsDownloadsRepos Using ThisPackages Using ThisMost Recent CommitTotal ReleasesLatest ReleaseOpen IssuesLicenseLanguage
Jekyll47,93977,4972,5256 days ago146January 30, 2023202mitRuby
:globe_with_meridians: Jekyll is a blog-aware static site generator in Ruby
Slate35,737
19 hours ago54apache-2.0SCSS
Beautiful static documentation for your API
Mkdocs17,9572,9711,686a day ago60September 18, 2023139bsd-2-clausePython
Project documentation with Markdown.
Zola12,389
5 days ago6June 19, 2017253mitRust
A fast static site generator in a single binary with everything built-in. https://www.getzola.org
Pelican11,9891,689116a month ago60November 15, 202346agpl-3.0Python
Static site generator that supports Markdown and reST syntax. Powered by Python.
Nextra10,02679an hour ago186October 24, 2023298mitTypeScript
Simple, powerful and flexible site generation framework with everything you love from Next.js.
Metalsmith7,8203,3782,1954 days ago50November 15, 202329mitJavaScript
An extremely simple, pluggable static site generator.
Docfx3,8151051a day ago191June 21, 2023291mitC#
Static site generator for .NET API documentation.
Assemble3,7883,6062725 years ago119May 20, 201729mitCSS
Get the rocks out of your socks! Assemble makes you fast at web development! Used by thousands of projects for rapid prototyping, themes, scaffolds, boilerplates, e-books, UI components, API documentation, blogs, building websites/static site generator, an alternative to Jekyll for gh-pages and more! Gulp- and grunt-friendly.
Wintersmith3,493956914 years ago49November 19, 201813mitCoffeeScript
A flexible static site generator
Alternatives To Docfx
Select To Compare


Alternative Project Comparisons
Readme

Build your docs with docfx

NuGet Help Wanted

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

  1. Install docfx as a global tool:

    dotnet tool install -g docfx
    
  2. Create and start a website locally:

    docfx init -y
    docfx build docfx_project\docfx.json --serve
    
  3. 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

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

Popular Static Site Generator Projects
Popular Markdown Projects
Popular Content Management Categories
Related Searches

Get A Weekly Email With Trending Projects For These Categories
No Spam. Unsubscribe easily at any time.
C Sharp
Markdown
Visual Studio
Publishing
Static Site Generator