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: Blazor, Markdown, .NET, C#, WinForms, WPF

Bot releases are hidden (Show)

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
docfx - Version 2.22

Published by qinezh about 7 years ago

  1. Support REST extensibility by rest.tagpage and rest.operationpage plugins, to split the original REST API page into smaller pages. Refer to plugins dashboard for more details.
  2. Bug fixed:
    1. Fix _rel unfound when href is url decoded.
    2. Fix #1886: Fails when project doesn't contain git remote information.
    3. Fix toc restruction to support expand child by sequence.
    4. Ignore default plugged assemblies when loading plugins.
docfx - Version 2.21.2

Published by qinezh over 7 years ago

  1. Allow manual define heading id:

    # <a id="a"></a>B

    will generate following html:

    <h1 id="a">B</h1>

  2. Bug fixes:

    1. Ignore default plugged assemblies when loading plugins.
docfx - Version 2.21.1

Published by vicancy over 7 years ago

  1. Bug fixes:
    1. Fix bug in tabbed content.
docfx - Version 2.21

Published by vicancy over 7 years ago

  1. Bug fixes:
    1. Fix bug in tabbed content.
docfx - Version 2.20

Published by vicancy over 7 years ago

  1. Add anchor links to default theme.
  2. Disable LRU cache as it has race condition bug and not easy to fix.
  3. PDF improvements:
    1. Intermediate html files are now removed by default, you can use --keepRawFiles option to keep them.
    2. Add syntax highlight to PDF, it is using highlight.js in client-side js.
    3. Add hook files to css and js, you can now customize PDF styles by adding your own main.css and main.js.
  4. Change the default behavior of incremental build that it is always based on the same cache folder (originally the cache folder changes in every build and copy historical files form last cache folder). You can use --cleanupCacheHistory option to cleanup the historical cache data.
  5. Bug fixes:
    1. Fix #1817: Error extracting metadata when containing constant surrogate unicode character.
    2. Fix #1655: Using hashtag in external cross reference broken.
    3. Fix #219: Fails when source code contains two type names that differ only in case
    4. Fix #164: Clean up previous auto-generated metadata YAML files when calling docfx metadata
    5. Fix #1797: the command docfx template list does not show the pdf template
    6. Fix #1803: Overriding example with *content in same file as other overrides doesn't work
    7. Fix #1807: XREF link to API doc with wildcard UID not getting generated
    8. Fix #1823: Metadata being generated from referenced projects
    9. FIx #1824: Change generated .manifest file to be indented and ordered.
docfx - Version 2.19.2

Published by vicancy over 7 years ago

  1. Bug fixes:
    1. ignore exception when saving cache.
    2. fix html tag in markdown.
docfx - Version 2.19.1

Published by vicancy over 7 years ago

  1. Bug fixes:
    1. ignore exception when saving cache.
    2. fix html tag in markdown.
Package Rankings
Top 17.68% on Formulae.brew.sh
Badges
Extracted from project README
NuGet ci nightly Help Wanted