Skip to content

Releases: dotnet/docfx

Version 1.9

16 May 06:26
Compare
Choose a tag to compare
  1. Breaking Change Refactor template system:

    1. The input data model now contains all the properties including system generated metadata starting with underscore _ and globally shared variables stored in __global. You can use docfx build --exportRawModel to view the data model.
    2. Preprocessor's transform function signature changes to:
    exports.transform = function (model){
        // transform the model 
        return model;
    }
  2. Provide a new embedded template statictoc with TOC generated in build time. Webpages generated by this template is PURE static and you can simply open the generated webpage file to take a preview, no local server is needed.

  3. Allow switch markdown engine.

  4. Allow export metadata to manifest file.

  5. Improve exclude logic to help avoid PathTooLongException. (#156)

  6. Provide with a config file named search-stopwords.json to customise full-text search stop-words. (#279)

  7. Bug fixes:

  8. Fix bug when cref contains loop. (#289)

  9. Make sure id is unique for each HTML in markdown transforming. (#224)

  10. Fix index range bugs in YamlHeaderParser. (#265)

Version 1.8.4

10 May 03:33
Compare
Choose a tag to compare
  1. Fix bug when outputFolder, basedirectory and destination are all not set
  2. fix <a> tag when href has invalid value with anchor

Version 1.8.3

09 May 11:38
Compare
Choose a tag to compare
  1. Fix bug for [!include()[]] when multiple articles in different subfolder including one file that v1.8.2 not resolved

Version 1.8.2

09 May 07:44
Compare
Choose a tag to compare
  1. Fix bug for [!include()[]] when multiple articles in different subfolder including one file

Version 1.8.1

04 May 07:37
Compare
Choose a tag to compare
  1. Fix bug when serialize attribute argument for type array. (#280)
  2. Fix bug when include file link to an anchor.
  3. Don't modify link when target file not existed.

Version 1.9.0-alpha-0091-g1c1b291

29 Apr 03:06
Compare
Choose a tag to compare
Pre-release

Support .NET Command Line Interface Project

Version 1.8

25 Apr 08:40
Compare
Choose a tag to compare
  1. Support multiple regions selection, code lines highlight and dedent length setting in Code Snippet. (#189)
  2. Support more tags in triple-slash-comments, e.g. lang, list, code, paramref and typeparamref.
  3. Add Example section to default template.
  4. Bug fixes:
    1. Fix bug when parsing triple-slash-comments. (#221)
    2. Fix syntax generation for VB module. (#260)

Version 1.7.2

20 Apr 05:40
Compare
Choose a tag to compare
  1. Fix markdown bug:
    • Ordered list continue with unordered list.
    • Support gfm comments.

Version 1.7.1

07 Apr 07:17
Compare
Choose a tag to compare
  1. Fix markdown bug:
    • Do NOT apply inline rule for html code.
    • Update em rule for gfm.

Version 1.7

07 Apr 02:54
Compare
Choose a tag to compare
  1. Behavior change
    1. For articles not in TOC, it's TOC file is the nearest TOC File in its output folder. Previously we only search the TOC File under the same input folder of the Not-In-Toc article.
  2. Provide more information for API reference documentation
    1. Type of events (#217)
    2. Parameters/returns for delegates (#218)
    3. Type parameter description (#204)
  3. Cross-reference is now supporting anchor# (#190)
  4. C# Code snippet now supports referencing source code using a region #engion (#160)
  5. Support TOC reference. With this syntax, we can combine multiple TOC files into a single TOC. (#161)
  6. Improve user experience when using docfx.msbuild in VS IDE
  7. Code refactor:
    1. We improved DocFX project structure in this release. Microsoft.DocAsCode.EntityModel namespace is no longer in use. Assemblies are separated into Microsoft.DocAsCode.Build, Microsoft.DocAsCode.DataContracts, and Microsoft.DocAsCode.Metadata namespace. All assemblies can be separately referenced through NuGet. In this way, it is much convenient for plugin writers to reference existing data models and utilities.