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.57.1

Published by openpublishbuild over 3 years ago

  1. Fix breaking theme by reverting bootstrap from 4.6.0 back to 3.4.1.
docfx - Version 2.57

Published by openpublishbuild over 3 years ago

  1. Improve display of enum flags. Thanks @mikernet! (#7043)
  2. Some improvements in docfx.console.targets. Thanks @alexrp! (#7117)
  3. New tools available: TocDocfxCreation, DocLinkChecker, DocLanguageTranslator and some examples. Thanks @Ellerbach! (#7231)
  4. Security updates:
    1. Replace use of MD5, SHA1 with SHA256. (#7149, #7157)
    2. Specify noopener/noreferer for external link. (#7204)
    3. Avoid reinterpreting DOM text as HTML without escaping meta-characters. (#7210)
    4. Check certificate revocation list in HTTP calls. (#7142)
    5. Upgrade some NPM, NuGet packages. (#7135, #7147)
    6. Migrate bower to NPM. (#7273)
    7. Enable CodeQL. (#7184)
  5. Bug fix:
    1. <code source=...> not work when using DLL + XML documents as input. Thanks @james-hunt-ra! (#7096)
    2. Sub navbar not fully shows if remove .html extension from URL. Thanks @CyberAndrii! (#7046)
docfx - Version 2.56.7

Published by openpublishbuild over 3 years ago

  1. Page UI updates:
    1. Support more inheritance levels in UI. Thanks @georgius! (#6880)
    2. Fix AnchorJS links hover issue. (#6910)
  2. Remove warning of $schema in JSON schema element. Thanks @kzu! (#6927)
  3. Fix MacOS case insensitive issue. Thanks @georgius! (#6888)
  4. Fix hasAttribute not working in API filter. (#5159)
  5. Fix xref service calls with empty uid. (#6917)
  6. Fix grammar issue in documentation. (#7063)
  7. Package updates:
    1. Upgrade axios to 0.21.1 (#6969)
    2. Upgrade iTextSharp to 5.5.12 (#7104)
    3. Upgrade YamlDotNet.Signed to 5.1.0 (#7107)
    4. Revert FSharp.Compiler.Service back to 17.0.1 as its references are missing on myget (#7029)
docfx - Version 2.56.6

Published by openpublishbuild almost 4 years ago

  1. Fix invalid table generation in XML documentation comments. Thanks @georgius! (#6864)
  2. Silently downgrade the error for not supported JSON schema key words temporarily. (#6870)
docfx - Version 2.56.5

Published by openpublishbuild almost 4 years ago

  1. Support more localized strings in theme. Thanks @alaincroisetiere (#6698)
  2. Upgrade JQuery to 3.5.1, Bootstrap to 3.4.1 to fix vulnerabilities. Thanks @alaincroisetiere (#6717)
docfx - Version 2.56.4

Published by openpublishbuild about 4 years ago

  1. Fix DocFX breaking under Linux and macOS. (#5785)
  2. Support more localized strings under zh-CN template. Thanks @alaincroisetiere! (#6648, #6649, #6659, #6660, #6667)
docfx - Version 2.56.3

Published by openpublishbuild about 4 years ago

  1. Bug fix:
    1. Display all levels in PDF TOC in default PDF template. Thanks @icnocop! (#3015)
    2. Fix alerts and other glyphicons styling not rendered in default PDF template. (#3016)
    3. Ignore resolving in example for swagger loading. (#6603)
docfx - Version 2.56.2

Published by openpublishbuild about 4 years ago

  1. Downgrade the severity of empty input files from warning to suggestion. (#6206)
  2. Fix style issue of NOTE sections in PDF. Thanks @Blake-Eryx! (#6211, #6271)
docfx - Version 2.56.1

Published by openpublishbuild over 4 years ago

  1. Bug fix:
    1. Fix updating links unexpectedly when building docs.microsoft.com docset for review purpose.
docfx - Version 2.56

Published by openpublishbuild over 4 years ago

  1. Support excluding default TOC in PDF. Thanks @Blake-Eryx! (#6146)
  2. Improvement and bug fix in code extension. (#6070)
  3. Bug fix:
    1. Fix TOC scrolling to wrong place. Thanks @Spongman! (#4470)
    2. Fix NOTE/WARNING/INFORMATION/CAUTION/TIP sections style. Thanks @Blake-Eryx! (#6082)
docfx - Version 2.55

Published by openpublishbuild over 4 years ago

  1. Support setting wkhtmltopdf.exe path in CLI option. Thanks @icnocop! (#6040)
  2. Make console output readable under white background. Thanks @paulpach! (#5309)
  3. Improvement and bug fix in code extension. (#5945, #5968)
  4. Ensure SourceBasePath present in manifest when a version contains no files. (#5960)
  5. Bug fix:
    1. Fix failing to search for methods by name. Thanks @paulpach! (#5695)
docfx - Version 2.54

Published by openpublishbuild over 4 years ago

  1. Supporting setting wkhtmltopdf.exe path in config. Thanks @icnocop! (#4422)
  2. Add video Markdown extension syntax. (#5945)
  3. Bug fix:
    1. Fix inaccurate error message when UIDs are duplicate. (#5898).
docfx - Version 2.53.1

Published by openpublishbuild over 4 years ago

  1. But fix:
    1. Downgrade error to warning for Markdown complex image.
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)
Package Rankings
Top 17.68% on Formulae.brew.sh
Badges
Extracted from project README
NuGet ci nightly Help Wanted
Related Projects
markdig

A fast, powerful, CommonMark compliant, extensible Markdown processor for .NET

25 May 2016 4,092
lazydocs

📖 Generate markdown API documentation from Google-style Python docstring. The lazy alternative t...

10 Nov 2020 198
ZooTree

ZooTree is a free, libre, and open source alternative to the mobile game Tree World.

07 Dec 2021 4
codever

Bookmarks, Snippets and Notes Manager for Developers & Co (website)

02 Oct 2016 352
Zag

Zag is a lightweight IDE for the Zig programming language. Zig *ZAG* \/\/\/

04 Jan 2022 2
markdoc

A powerful, flexible, Markdown-based authoring framework.

09 May 2022 7,023
PSDocs

Generate documentation from Infrastructure as Code (IaC).

15 Aug 2017 145
ps-docs

Generate documentation from Infrastructure as Code (IaC) using GitHub Actions.

04 Jul 2021 17
elegant-cli

✨ Build SEO-friendly websites, super fast full-stack web applications, and much more with Elegant...

10 Mar 2023 172
mkdocs

Project documentation with Markdown.

11 Jan 2014 18,205
marktext

📝A simple and elegant markdown editor, available for Linux, macOS and Windows.

12 Nov 2017 44,532
vscode-docs

Public documentation for Visual Studio Code

26 Aug 2015 5,453
uOffice

uOffice (Ultimate Office) is an open source office suite with tons of features and support for ma...

24 Jun 2020 6
tsdoc

A doc comment standard for TypeScript

01 Mar 2018 4,659
eyes3scribe

Automatically creates HTML documentation files for BASH/Shell source code using markdown & python...

05 Oct 2023 1