docfx

Static site generator for .NET API documentation.

MIT License

Downloads
38
Stars
4K
Committers
254

Bot releases are visible (Hide)

docfx - Version 2.7

Published by qinezh almost 8 years ago

  1. Improve markdown engine performance.
  • Improve regex.
  • Add regex timeout.
  1. Fix bugs in markdown parser.
  2. Refine xref.
  • Provide more options.
  • Support options in query string.
  1. Support query string in toc href.
  2. Remove debug information in html.
  3. Add metadata command option to disable rendering triple-slash-comments as markdown.
  4. Fix bug in merging properties.
  5. Support extension for preprocessor file in default template. (https://github.com/dotnet/docfx/issues/662)
  6. Improve error/warning message.
docfx - Version 2.6.3

Published by qinezh about 8 years ago

  1. minor: fix the Renderer
docfx - Version 2.6.2

Published by qinezh about 8 years ago

  1. Improve markdown engine performance.
  • Improve regex.
  • Add regex timeout.
  1. Fix bugs in markdown parser.
  2. DFM: Support code in table
docfx - Version 2.6.1

Published by qinezh about 8 years ago

  1. Fix argumentnullexception for generating overload item.
  2. Add serializable attribute.
  3. Use mark.js to highlight keywords.
docfx - Version 2.6

Published by qinezh about 8 years ago

  1. Remove rest resolved cache.
  2. Fix assert fail in metadata. (https://github.com/dotnet/docfx/issues/741)
  3. Add new command option: repositoryRoot.
docfx - Version 2.5.4

Published by qinezh about 8 years ago

  1. Fix isssue #719 that assertion failed.
docfx - Version 2.5.3

Published by qinezh about 8 years ago

  1. Update documenation
  2. Remove debug build option in Release configuration
docfx - Version 2.5.2

Published by qinezh about 8 years ago

  1. Fix error message for invalid file link.
docfx - Version 2.5.1

Published by qinezh about 8 years ago

  1. Support attribute filter to filter out attributes.
  2. Support choosing git URL pattern. (https://github.com/dotnet/docfx/issues/677)
  3. Fix bug for line number is 0.
docfx - Version 2.5

Published by qinezh about 8 years ago

  1. Add source file and line number for warning invalid file/uid link.
  2. Fix bugs in markdown table.
docfx - Version 2.4

Published by qinezh about 8 years ago

  1. Update default template theme.
  2. Fix resolving properties for swagger.
  3. Fix bugs in markdown.
  4. Fix id in title (following GitHub rule).
  5. Fix strikeout not work in dfm.
  6. Fix tight list item behavior.
  7. Fix line number in table.
docfx - Version 2.3.1

Published by qinezh about 8 years ago

  1. Remain TOC's href in it's original relative path form if unable to resolve.
docfx - Version 2.3

Published by qinezh about 8 years ago

  1. Support emoji in markdown content.
  2. Upgrade yamldotnet to 3.9.
  3. Refine markdown validation.
  4. Support separated meta json file.
  5. Change hightlight.js theme to github-gist.
  6. Support '.json' as supported swagger file extension.
  7. Support topicHref and tocHref to specify homepage toc.
  8. Support customized contribute repository and branch for "Improve this Doc" button. (https://github.com/dotnet/docfx/issues/482)
  9. Improve message for docfx.exe template command.
docfx - Version 2.2.2

Published by qinezh over 8 years ago

  1. Fix bug in .manifest file.
docfx - Version 2.2.1

Published by qinezh over 8 years ago

  1. Fix bug when metadata incremental check
  2. Move post process out of DocumentBuilder
docfx - Version 2.2

Published by qinezh over 8 years ago

  1. Support multi-version site. (https://github.com/dotnet/docfx/issues/396)
  2. Support loop reference for Swagger Rest API. (https://github.com/dotnet/docfx/issues/223)
  3. Support plug-in for post processor.
  4. Support href for see/seealso tags.
  5. Improve API reference documentation of namespace and enum.
  6. Update prerequisite to build docfx.
  7. Update manifest schema.
  8. Add chocolatey support in CI script.
  9. Provide with options in build.cmd.
  10. Bug fixes:
    1. syntax for static class is incorrect.
    2. improve warning message about global namespace class. (https://github.com/dotnet/docfx/issues/417)
    3. fix normalizexml bug for empty <code></code> in tripleslashcomment.
docfx - Version 2.1

Published by qinezh over 8 years ago

  1. Support for xref zip file in relative path.
  2. Support anchor in toc file.
  3. Support plug-in for validating markdown input metadata.
  4. Add output file md5 hashes.
  5. Breaking Url Rename generic type file name in metadata step

E.g. System.Func<T> will generate System.Func-1.yml instead of System.Func1.yml, and after build the url will be System.Func-1.htmlinstead ofSystem.Func%601.html`.

To keep old behavior, please add following option in metadata part in docfx.json:

"useCompatibilityFileName": true
  1. Display extension methods in API reference documentation
  2. Provide with option _displayLangs in docfx.json to choose which language version you want to show.
  3. Support more Swagger syntax:
docfx - Version 2.1.0-cli-alpha

Published by qinezh over 8 years ago

Support .NET Command Line Interface Project

docfx - Version 2.1.0-alpha

Published by qinezh over 8 years ago

docfx - Version 2.0.2

Published by qinezh over 8 years ago

  1. Support localization tokens in DFM.
Package Rankings
Top 17.68% on Formulae.brew.sh
Badges
Extracted from project README
NuGet ci nightly Help Wanted