docfx

Static site generator for .NET API documentation.

MIT License

Downloads
38
Stars
4K
Committers
254
View Code on GitHub Visit Website View on X
Ecosystems: Markdown, Blazor, .NET, C#, WinForms, WPF

Bot releases are visible (Hide)

docfx - Version 2.30

Published by vicancy almost 7 years ago

  1. Improve DFM performance for em rule (#2339)
  2. Added multiple merge operation support (#2287) [by @lextm]
  3. Bug fixes:
    1. Fix bug for reading xrefmap with base url. (#2349)
docfx - Version 2.29.1

Published by vicancy almost 7 years ago

  1. Fix split member plugin's bug for enum page
docfx - Version 2.29

Published by vicancy almost 7 years ago

  1. Support generating API reference for JavaScript (#2220)
  2. Bug fixes:
    1. Fix bug for query xref service (#2283)
docfx - Version 2.28.3

Published by vicancy almost 7 years ago

  1. Fix toc race condition and improve perf
docfx - Version 2.28.2

Published by qinezh almost 7 years ago

  1. Bug fixes:
    1. Fix issues running under mono (#2262, #1856)
    2. Fix VS17 15.5 support (#2265)
docfx - Version 2.28.1

Published by vicancy almost 7 years ago

  1. Bug fixes:
    1. Fix .NET core .csproj files support (#1752)
docfx - Version 2.28

Published by vicancy almost 7 years ago

  1. Add warning throttling. (#2187)
  2. Enable schema validation for SDP.
  3. Bug fixes:
    1. Fix markdown link behavior. (#2181)
    2. Fix xref map sorted comparer. (#2191)
    3. Fix yaml deserialize for int64. (#2193)
    4. Fix xref query filter. (#2195)
    5. Fix docfx metadata failure after VS2017 Update 15.3. (#1969)
    6. Provide MetadataOutputFolder MSBuild parameter with docfx.console. (#2194)
docfx - Version 2.27

Published by vicancy almost 7 years ago

  1. Improve code snippet, add cs snippet for cshtml, add vb snippet for vbhtml.
  2. Support overwrite in SDP
docfx - Version 2.26.4

Published by qinezh almost 7 years ago

  1. Improve performance for markdown parser with aggregator.
  2. Fix bug: SerializationException for SitemapOptions.
docfx - Version 2.26.3

Published by vicancy about 7 years ago

  1. Fix missing bookmark in TOC's href.
docfx - Version 2.26.1

Published by vicancy about 7 years ago

  1. Skip log warning for invalid YAML header at the middle of article.
docfx - Version 2.26

Published by vicancy about 7 years ago

  1. New feature:

    1. Support new syntax in Markdown: tabbed content 
    # [Csharp](#tab/csharp)
```cs
Console.WriteLine("Hello world");
```
# [JavaScript](#tab/js)
```js
console.log('hello world');
```

  2. Fix bugs:

    1. Update DFM XREF short format.
    2. Update Markdown EM rule.
docfx - Version 2.25.2

Published by qinezh about 7 years ago

  1. Fix post-processor incremental bug that incremental post-processor is always disabled
docfx - Version 2.25.1

Published by vicancy about 7 years ago

  1. Disable schema validation in schema-driven document processor temporarily.
  2. Disable loading overwrite documents in schema-driven document processor temporarily.
docfx - Version 2.25

Published by qinezh about 7 years ago

  1. Use wbr instead of zero width space
  2. Remove warning invalid file link when customized href generator can resolve it.
  3. Support generating sitemap with at least "sitemap": { "baseUrl": "https://yourwebsite.com/" } defined in "build" section of docfx.json (https://github.com/dotnet/docfx/issues/1979)
  4. Support responsive table: https://github.com/dotnet/docfx/issues/2024
  5. Bug fixed:
    1. Multithreads issue for reading xref zip file.
    2. 404 issue for generated site. https://github.com/dotnet/docfx/issues/1858
docfx - Version 2.24

Published by vicancy about 7 years ago

  1. Log warning for manage reference yaml file without yaml mime.
  2. Obsolete external reference. Please use xref instead.
  3. Add xref query client.
  4. Upgrade Roslyn's CodeAnalysis assemblies to latest 2.3.1
  5. Schema-driven document processor related
    1. support metadata keyword
    2. support all the functionalities defined in the spec
  6. Advanced xref syntax support: <xref uid="System.String" template="partials/layout_section.tmpl">
  7. Support global metadata and file metadata for TOC files
  8. Add class level implements to default template. https://github.com/dotnet/docfx/issues/1223
  9. Obsolete version and use group instead.
  10. Bug fixed:
  11. Fix #1982: c# 7.1 feature default is not correctly handled
docfx - Version 2.23.1

Published by vicancy about 7 years ago

  1. Fix https://github.com/dotnet/docfx/issues/1982 to support new c# 7.1 feature
docfx - Version 2.23

Published by qinezh about 7 years ago

  1. Improve error message for invalid toc yaml file.
  2. Use xhtml for dfm default setting.
  3. Add language support for aspx-cs and aspx-vb in code snippet.
  4. Bug fixed:
      1. Fix #1825: ArgumentNullException when EII implements a member with EditorBrowsableState.Never.
    2. Fix #1951, #1905: Running DocFX from outside the folder fails
    3. Fix #1915: Cannot generate docs of two assemblies
    4. Fix #1900: Add back Microsoft.CodeAnalysis.Csharp.Features.dll dependency
docfx - Version 2.22.3

Published by qinezh about 7 years ago

  1. Upgrade Microsoft.Net.Compilers to 2.3.1
docfx - Version 2.22.2

Published by vicancy about 7 years ago

  1. Bug fixed:
    1. Fix incremental bug that ExtensionData in ReferenceViewModel is log in cache file
Package Rankings
Top 17.68% on Formulae.brew.sh
Badges
Extracted from project README
NuGet ci nightly Help Wanted