Static site generator for .NET API documentation.
MIT License
Bot releases are visible (Hide)
Published by yufeih about 1 year ago
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.*
.
docfx serve
command by @filzrev in https://github.com/dotnet/docfx/pull/8934
Docfx.App
by @dpvreony in https://github.com/dotnet/docfx/pull/8939
Full Changelog: https://github.com/dotnet/docfx/compare/v2.67.5...v2.70.0
Published by yufeih over 1 year ago
Full Changelog: https://github.com/dotnet/docfx/compare/v2.67.3...v2.67.5
Published by yufeih over 1 year ago
Full Changelog: https://github.com/dotnet/docfx/compare/v2.67.3...v2.67.4
Published by yufeih over 1 year ago
templates/dist/.gitignore
file by @filzrev in https://github.com/dotnet/docfx/pull/8817
Full Changelog: https://github.com/dotnet/docfx/compare/v2.67.2...v2.67.3
Published by yufeih over 1 year ago
🎉 New Features
Full Changelog: https://github.com/dotnet/docfx/compare/v2.67.1...v2.67.2
Published by yufeih over 1 year ago
on
word. by @VaclavElias in https://github.com/dotnet/docfx/pull/8755
Full Changelog: https://github.com/dotnet/docfx/compare/v2.67.0...v2.67.1
Published by yufeih over 1 year ago
styles
folder to public
for the modern template to locate custom scripts and styles in main.js
and main.css
._googleAnalyticsTagId
metadata in by @yufeih in https://github.com/dotnet/docfx/pull/8733
Full Changelog: https://github.com/dotnet/docfx/compare/v2.66.2...v2.67.0
Published by yufeih over 1 year ago
Full Changelog: https://github.com/dotnet/docfx/compare/v2.66.1...v2.66.2
Published by yufeih over 1 year ago
Full Changelog: https://github.com/dotnet/docfx/compare/v2.66.0...v2.66.1
Published by yufeih over 1 year ago
Full Changelog: https://github.com/dotnet/docfx/compare/v2.65.3...v2.66.0
Published by yufeih over 1 year ago
Full Changelog: https://github.com/dotnet/docfx/compare/v2.65.2...v2.65.3
Published by yufeih over 1 year ago
Full Changelog: https://github.com/dotnet/docfx/compare/2.65.1...v2.65.2
Published by yufeih over 1 year ago
Full Changelog: https://github.com/dotnet/docfx/compare/v2.65.0...2.65.1
Published by yufeih over 1 year ago
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 />
.
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]
```
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)$$
Full Changelog: https://github.com/dotnet/docfx/compare/v2.64.0...v2.65.0
Published by yufeih over 1 year ago
This release improves link generation for C# documentation comment in a couple of areas:
<see langword="">
now properly resolves to URLs pointing to https://learn.microsoft.com.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.
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.
Full Changelog: https://github.com/dotnet/docfx/compare/v2.63.1...v2.64.0
Published by yufeih over 1 year ago
Full Changelog: https://github.com/dotnet/docfx/compare/v2.63.0...v2.63.1
Published by yufeih over 1 year ago
This release features a brand new modern
site template based on bootstrap 5 with a lot of visual and usability improvements:
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"]
.
_appName
after logo by @yufeih in https://github.com/dotnet/docfx/pull/8438
expanded
property by @yufei in https://github.com/dotnet/docfx/pull/8498
Full Changelog: https://github.com/dotnet/docfx/compare/v2.62.2...v2.63.0
Published by yufeih over 1 year ago
Full Changelog: https://github.com/dotnet/docfx/compare/v2.62.1...v2.62.2
Published by yufeih over 1 year ago
Full Changelog: https://github.com/dotnet/docfx/compare/v2.62.0...v2.62.1
Published by yufeih over 1 year ago
highlight.js
with latest C# syntax highlighting by @yufeih in https://github.com/dotnet/docfx/pull/8395
Full Changelog: https://github.com/dotnet/docfx/compare/v2.61.0...v2.62.0