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 visible (Hide)

docfx - Version 2.53

Published by openpublishbuild over 4 years ago

  1. Support extracting metadata from FSharp projects incrementally. Thanks @saul! (#5810)
  2. Support XrefService as parameter. e.g. docfx --xrefService https://xref.docs.microsoft.com/query?uid={uid}. (#5786)
  3. Feature, improvement and bug fix in several Markdown extension syntax. (#5792, #5804, #5838, #5857)
  4. Do not warn when certain output is empty. (#5878)
  5. Bug fix:
    1. Fix crash when building FSharp projects with override methods. Thanks @saul! (#5811)
    2. Fix applying template preprocessor failure for Python reference in some cases. (#5781)
    3. Fix PDF outline issue, add check for user style sheet existence. Thanks @icnocop (#5490, #5858)
docfx - Version 2.52

Published by openpublishbuild over 4 years ago

  1. Improve readibility of default theme (#5156). Thanks @djee-ms!
  2. Support F# v4.5 language features (#3679). Thanks @smindinvern!
  3. DocFX returns -1 for errors that cause notable result missing, 1 for crash or severe errors, 0 for success. Before, DocFX returns 1 when error happens no matter which kind it is. (#5734)
  4. Bug fix:
    1. Fix TOC filter in statictoc template for Edge and IE browser (#5651). Thanks @Blake-Eryx!
docfx - Version 2.51

Published by openpublishbuild over 4 years ago

  1. Support fetching xref map from fallback folder. (#5593)
  2. Improve error handling to remove some duplicate error logs.
  3. Improvement and bug fix in code extension.
docfx - Version 2.50

Published by openpublishbuild over 4 years ago

  1. Avoid URL encoding allowed URI characters ( and ) when generating links (#5537).
  2. Ensure more deterministic output (#4569). Thanks fibann!
  3. More chance to build incrementally when plugin assemblies have only slight change (#5572).
  4. Bug fix:
    1. Fix crash when inheritdoc targets non-existent definition (#5561).
    2. Fix several code extension bugs (#5546).
docfx - Version 2.49

Published by openpublishbuild over 4 years ago

  1. Add cref attribute support (#1306) for inheritdoc and fix copying from templated sources (#1516). Thanks @amirebrahimi.
  2. Bug fix:
    1. Fix TOC filter returning unrelated results (#5401). Thanks @zwfars
    2. Fix duplicate error when TOC is invalid (#5464).
    3. Fix several code extension bugs (#5510 #5527).
docfx - Version 2.48.1

Published by openpublishbuild almost 5 years ago

  1. Bug fix:
    1. Fix failure building UWP project. (#5011)
    2. Fix former post processor's metadata changes lost in later post processor. (#5366)
docfx - Version 2.48

Published by openpublishbuild almost 5 years ago

  1. Support fetching region from referenced XML code snippet in XML documentation comments. (#5319) Thanks @Laniusexcubitor!
  2. Bug fix:
    1. Fix NullReferenceExcpetion when input YAML content is empty file. (#5254)
docfx - Version 2.47

Published by openpublishbuild almost 5 years ago

  1. Add persistence to the TOC filter (#5164). Thanks @jo3w4rd!
  2. Bug fix:
    1. Fix StackOverflowExcpetion when resolving cross reference. (#4857)
    2. Fix parsing ~/ in link path. (#5223)
docfx - Version 2.46

Published by openpublishbuild about 5 years ago

  1. Support Jupyter Notebook in code snippet (#4989, #5000). Thanks @pravakarg, @sdgilley!
  2. Upgrade to Microsoft.CodeAnalysis 3.3.1 for C# 8.0 support (#5163). Thanks @dlech!
  3. Improve the default template for TypeScript documentation (#5128). Thanks @rbuckton!
  4. Improve logging of template preprocessor errors (#5099). Thanks @mcm-ham!
  5. Bug fix:
    1. fix duplicate warnings when include the same file multiple times. (#5093)
docfx - Version 2.45.1

Published by openpublishbuild about 5 years ago

  1. Improve performance by upgrading Jint to 2.11.58. (#5032)
  2. Resolve UID from xrefmap respecting the order defined in docfx.json. (#5094)
  3. Bug fix:
    1. Fix incremental build error when previous build has no content. (#5010)
    2. Fix PDF cover page not work. (#5077)
    3. Enforce trailing ] when matching file inclusion Markdown syntax. (#5091)
docfx - Version 2.45

Published by openpublishbuild about 5 years ago

  1. Support linking to repository from dev.azure.com automatically. (#4493)
  2. Unify log code InvalidInternalBookmark and InvalidExternalBookmark into InvalidBookMark.
  3. Expand environment variables in metadata/build src section when looking for input files. (#4983)
docfx - Version 2.43.5

Published by openpublishbuild about 5 years ago

docfx - Version 2.44

Published by openpublishbuild about 5 years ago

docfx - Version 2.43.4

Published by openpublishbuild about 5 years ago

docfx - Version 2.43.3

Published by openpublishbuild over 5 years ago

docfx - Version 2.43.2

Published by openpublishbuild over 5 years ago

  1. Bug fix:
    1. Fix running under Linux/Mono (#4728). Thanks @tibel!
    2. Fix PDF build failure under Azure DevOps with a new config noStdin (#4488). Thanks @oleksabor!
    3. Fix truncation issue in side bar (#3166). Thanks @icnocop!
    4. Fix a scrolling issue when clicking the same anchor twice (#3133). Thanks @icnocop!
docfx - Version 2.43.1

Published by openpublishbuild over 5 years ago

  1. Support Visual Studio 2019. (#4437)

    [Note] This will break running under Linux/Mono. Before it is fixed, you can keep using v2.42.4.

docfx - Version 2.43

Published by openpublishbuild over 5 years ago

  1. Drop project.json support. (#4573)
docfx - Version 2.42.4

Published by openpublishbuild over 5 years ago

  1. Drop project.json support. (#4573)
docfx - Version 2.42.3

Published by openpublishbuild over 5 years ago

  1. Bug fix: use remove instead of add to remove duplicate items.
Package Rankings
Top 17.68% on Formulae.brew.sh
Badges
Extracted from project README
NuGet ci nightly Help Wanted