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

Bot releases are visible (Hide)

docfx - Version 2.12.1

Published by qinezh over 7 years ago

  1. Bug fixes: clickable images links in markdown topics are no longer being rendered correctly.
docfx - Version 2.12

Published by qinezh over 7 years ago

  1. Bug fixes:
  2. default template: Do not load search-worker.js when search is disabled in docfx.js
  3. C# region support for code snippets broken by #endregion with extra text. https://github.com/dotnet/docfx/issues/1200
  4. Markdown list continue with def.
  5. Markdown link rule is not allowed in link text.
  6. Markdown list restore wrong context.
  7. Metadata _docfxVersion can't be overwritten. https://github.com/dotnet/docfx/issues/1251
  8. statictoc template out of sync with default template. https://github.com/dotnet/docfx/issues/1256
  9. Fix footer covering sidetoc. https://github.com/dotnet/docfx/issues/1222
docfx - Version 2.11.3

Published by qinezh over 7 years ago

  1. Add support for title attribute specification in TOC.md files
docfx - Version 2.11.2

Published by qinezh almost 8 years ago

  1. Fix bug in functions exported by embedded common template.
docfx - Version 2.11.1

Published by qinezh almost 8 years ago

docfx - Version 2.11

Published by qinezh almost 8 years ago

  1. Export custom href generator.
  2. Use attribute driven data model for ManagedReference
  3. Bug fixes:
  4. Generate overload name/fullname form generic method should not contain method parameter.
  5. Fix href for markdown link to non-exist files in include files.
docfx - Version 2.11(Pre-Release)

Published by qinezh almost 8 years ago

  1. Export custom href generator.
  2. Bug fixes:
  3. Generate overload name/fullname form generic method should not contain method parameter.
  4. Fix href for markdown link to non-exist files in include files.
docfx - Version 2.10.2

Published by qinezh almost 8 years ago

  1. Remove the check for character ? in relative path.
  2. LinkFileSystem: not throw DirectoryNotFoundException when no output.
docfx - Version 2.10.1

Published by qinezh almost 8 years ago

  1. Relative path add check for character ?*.
docfx - Version 2.10

Published by qinezh almost 8 years ago

  1. Bug fixes:
  2. Markdown table content is misplaced if there is empty column in it.
  3. Markdown include should not share link context.
  4. Fix rawTitle when article's first line is HTML comment.
docfx - Version 2.9.3

Published by qinezh almost 8 years ago

  1. hotfix for wrong file link check message.
docfx - Version 2.9.2

Published by qinezh almost 8 years ago

  1. Remove commit id to avoid config hash changed.
docfx - Version 2.9.1

Published by qinezh almost 8 years ago

  1. Enable to show derivedClass.
  2. Add log for config hash.
docfx - Version 2.9

Published by qinezh almost 8 years ago

  1. Breaking Change Using <span class="xxx"> for languageKeyWord, paramref and typeparamref in generated yml files, instead of using <em> and <strong>. Change default template accordingly.
  2. Remove project Microsoft.DocAsCode.Utility, move class to Microsoft.DocAsCode.Common.
  3. Get documentation's git information with git command instead of GitSharp.
  4. REST:
  • Support remarks to be overwritten.
  • Support reference in parameters to be overwritten.
  • Support DFM syntax in swagger description
  1. Bug fixes:
  2. Fix inherited member's name when xref unresolved.
  3. Fix missing items in breadcrumb. (https://github.com/dotnet/docfx/issues/944)
  4. Fix generating overload method names from generic method.
  5. Fix full text search not work in index page.
  6. Fix the warning that no highlight function defined.
docfx - Version 2.8.2

Published by qinezh almost 8 years ago

  1. Fix bug: throw error when md contain wrong path..
docfx - Version 2.8.1

Published by qinezh almost 8 years ago

  1. Fix bug: RelativePath.TryParse should not throw error when path contains invalid path characters.
docfx - Version 2.8

Published by qinezh almost 8 years ago

  1. Improve markdown engine:
  • Remove paragraph rule.
  • Improve parser performance.
  1. Report bookmarks in template preprocessor, which is used in URL segment when resolving cross reference.
  2. Support customizing logo and favicon through metadata. (https://github.com/dotnet/docfx/pull/892)
  3. Refine the warning message of invalid bookmark.
  4. Improve layout for print. (https://github.com/dotnet/docfx/issues/852)
  5. Remove the usage of FileModel.LocalPathFromRepoRoot. This property is marked Obsolete.
  6. Copy PathUtility, RelativePath, StringExtension and FilePathComparer from project Microsoft.DocAsCode.Utility to Microsoft.DocAsCode.Common. The copied classes in project Microsoft.DocAsCode.Utility are kept there for bits compatibility and marked Obsolete.
  7. Add command option docfx -v to show version of DocFX
  8. Bug fixes:
  9. concurrency issue of Logger.
  10. unable to handle file link with query string.
  11. unable to resolve uid for in html <a href="xref:...">.
  12. display specName wrong for generic type. (https://github.com/dotnet/docfx/issues/896)
  13. breadcrumb rendered wrong when multiple toc item matched.
  14. subcommand metadata can't specify DocFX config file
docfx - Version 2.7.3

Published by qinezh almost 8 years ago

  1. Fix bookmark validation failed when link contains illegal characters.
  2. Fix xref to fall back to uid.
docfx - Version 2.7.2

Published by qinezh almost 8 years ago

  1. Fix xref with query string not resolved.
  2. Fix relative path when validating bookmark.
docfx - Version 2.7.1

Published by qinezh almost 8 years ago

  1. Search embedded resource prior to local resource
Package Rankings
Top 17.68% on Formulae.brew.sh
Badges
Extracted from project README
NuGet ci nightly Help Wanted