docfx

Static site generator for .NET API documentation.

MIT License

Downloads
38
Stars
4K
Committers
254

Bot releases are hidden (Show)

docfx - v2.70.0

Published by yufeih about 1 year ago

Docfx as .NET Foundation Project

Starting from v2.70.0, docfx has been fully transitioned to be a .NET Foundation project entirely driven by the community for the interest of the community.

Given the ownership change, we are renaming the NuGet package names, assembly names and namespace names from Microsoft.DocAsCode.* to Docfx.*.

What's Changed

💥 Breaking Changes

🎉 New Features

🐞 Bug Fixes

🔧 Engineering

📄 Documentation

New Contributors

Full Changelog: https://github.com/dotnet/docfx/compare/v2.67.5...v2.70.0

docfx - v2.67.5

Published by yufeih over 1 year ago

What's Changed

🎉 New Features

🐞 Bug Fixes

📄 Documentation

🔧 Engineering

Full Changelog: https://github.com/dotnet/docfx/compare/v2.67.3...v2.67.5

docfx - v2.67.4

Published by yufeih over 1 year ago

What's Changed

🎉 New Features

🐞 Bug Fixes

📄 Documentation

Full Changelog: https://github.com/dotnet/docfx/compare/v2.67.3...v2.67.4

docfx - v2.67.3

Published by yufeih over 1 year ago

What's Changed

🎉 New Features

🐞 Bug Fixes

🔧 Engineering

📄 Documentation

New Contributors

Full Changelog: https://github.com/dotnet/docfx/compare/v2.67.2...v2.67.3

docfx - v2.67.2

Published by yufeih over 1 year ago

What's Changed

🎉 New Features

🐞 Bug Fixes

Full Changelog: https://github.com/dotnet/docfx/compare/v2.67.1...v2.67.2

docfx - v2.67.1

Published by yufeih over 1 year ago

What's Changed

🎉 New Features

🔧 Engineering

📄 Documentation

Full Changelog: https://github.com/dotnet/docfx/compare/v2.67.0...v2.67.1

docfx - v2.67.0

Published by yufeih over 1 year ago

What's Changed

💥 Breaking Changes

  • https://github.com/dotnet/docfx/pull/8682: If you have a custom template based on the modern template, rename the styles folder to public for the modern template to locate custom scripts and styles in main.js and main.css.

🎉 New Features

🐞 Bug Fixes

📄 Documentation

New Contributors

Full Changelog: https://github.com/dotnet/docfx/compare/v2.66.2...v2.67.0

docfx - v2.66.2

Published by yufeih over 1 year ago

What's Changed

🐞 Bug Fixes

Full Changelog: https://github.com/dotnet/docfx/compare/v2.66.1...v2.66.2

docfx - v2.66.1

Published by yufeih over 1 year ago

What's Changed

🐞 Bug Fixes

📄 Documentation

New Contributors

Full Changelog: https://github.com/dotnet/docfx/compare/v2.66.0...v2.66.1

docfx - v2.66.0

Published by yufeih over 1 year ago

What's Changed

🎉 New Features

🐞 Bug Fixes

📄 Documentation

New Contributors

Full Changelog: https://github.com/dotnet/docfx/compare/v2.65.3...v2.66.0

docfx - v2.65.3

Published by yufeih over 1 year ago

What's Changed

🐞 Bug Fixes

📄 Documentation

New Contributors

Full Changelog: https://github.com/dotnet/docfx/compare/v2.65.2...v2.65.3

docfx - v2.65.2

Published by yufeih over 1 year ago

What's Changed

🎉 New Features

📄 Documentation

Full Changelog: https://github.com/dotnet/docfx/compare/2.65.1...v2.65.2

docfx - v2.65.1

Published by yufeih over 1 year ago

What's Changed

🐞 Bug Fixes

📄 Documentation

New Contributors

Full Changelog: https://github.com/dotnet/docfx/compare/v2.65.0...2.65.1

docfx - v2.65.0

Published by yufeih over 1 year ago

Enhanced <inheritdoc /> support

The <inheritdoc /> tag for C# documentation comments now behaves more like Visual Studio and Visual Studio Code. Members automatically inherit documentation from their base class or interfaces, including base class library types. Additionally, you can use the cref and path attributes to customize the behavior of <inheritdoc />.

Mermaid Diagrams in markdown

You can now create Mermaid diagrams using markdown code blocks. Here's a simple example:

```mermaid
flowchart LR
A[Hard] -->|Text| B(Round)
B --> C{Decision}
C -->|One| D[Result 1]
C -->|Two| E[Result 2]
```

LaTeX Math Expression in markdown

Incorporate LaTeX math expressions in your documentation using the $ or $$ delimiter. For instance:

$$\left( \sum_{k=1}^n a_k b_k \right)^2 \leq \left( \sum_{k=1}^n a_k^2 \right) \left( \sum_{k=1}^n b_k^2 \right)$$

What's Changed

💥 Breaking Changes

🎉 New Features

💪 Other Changes

Full Changelog: https://github.com/dotnet/docfx/compare/v2.64.0...v2.65.0

docfx - v2.64.0

Published by yufeih over 1 year ago

C# documentation comment link enhancements

This release improves link generation for C# documentation comment in a couple of areas:

  • Links to base class libraries are generated automatically without using the xref service or extra config. This is done by calculating the references to APIs hosted on https://learn.microsoft.com/dotnet/api using an URL pattern offline.
  • View source is now available for assemblies as input if
    • The assembly enables SourceLink
    • A PDB file exist next to the assembly file.
  • Links to types in dependency assemblies produces URLs pointing to the API source code location if:
    • The dependency assembly enables SourceLink
    • A PDB file exist next to the assembly file.
  • <see langword=""> now properly resolves to URLs pointing to https://learn.microsoft.com.

MemberPage as a first class feature

The memberpage plugin is now replaced by a first-class feature using the experimental { "memberLayout": "SeparatePages" } config. See this example on how to enable the behavior in docfx.json.

NOTE: This new feature has been manually tested for the default templates, the modern template and the statictoc template, but there might be glitches in some edge cases.

Sunset DFM markdown engine

The MarkdownLite and DFM markdown engine is removed from docfx in this release. DFM users are encouraged to update to markdig for a commonmark compliant markdown parser, a rich markdown extension eco-system and better performance.

What's Changed

💥 Breaking Changes

🎉 New Features

🐞 Bug Fixes

📄 Documentation

Full Changelog: https://github.com/dotnet/docfx/compare/v2.63.1...v2.64.0

docfx - v2.63.1

Published by yufeih over 1 year ago

What's Changed

🎉 New Features

🔧 Engineering

New Contributors

Full Changelog: https://github.com/dotnet/docfx/compare/v2.63.0...v2.63.1

docfx - v2.63.0

Published by yufeih over 1 year ago

New Modern Template

This release features a brand new modern site template based on bootstrap 5 with a lot of visual and usability improvements:

  • Supports both dark and light themes
  • Match .NET API reference docs with https://learn.microsoft.com
  • Usability improvements such as code copy, clickable images, external link icons, better API text breaks, link to GitHub, etc.

The docfx official site has also been updated to use the new template. To use the modern template in your website, set the template to ["default", "modern"].

What's Changed

💥 Breaking Changes

🎉 New Features

🐞 Bug Fixes

🔧 Engineering

📄 Documentation

New Contributors

Full Changelog: https://github.com/dotnet/docfx/compare/v2.62.2...v2.63.0

docfx - v2.62.2

Published by yufeih over 1 year ago

What's Changed

🐞 Bug Fixes

Full Changelog: https://github.com/dotnet/docfx/compare/v2.62.1...v2.62.2

docfx - v2.62.1

Published by yufeih over 1 year ago

What's Changed

🐞 Bug Fixes

Full Changelog: https://github.com/dotnet/docfx/compare/v2.62.0...v2.62.1

docfx - v2.62.0

Published by yufeih over 1 year ago

What's Changed

💥 Breaking Changes

🎉 New Features

🐞 Bug Fixes

📄 Documentation

New Contributors

Full Changelog: https://github.com/dotnet/docfx/compare/v2.61.0...v2.62.0

Package Rankings
Top 17.68% on Formulae.brew.sh
Badges
Extracted from project README
NuGet ci nightly Help Wanted
Related Projects