Releases: dotnet/docfx
Releases · dotnet/docfx
Version 1.9
-
Breaking Change Refactor template system:
- 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 usedocfx build --exportRawModel
to view the data model. - Preprocessor's
transform
function signature changes to:
exports.transform = function (model){ // transform the model return model; }
- The input data model now contains all the properties including system generated metadata starting with underscore
-
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. -
Allow switch markdown engine.
-
Allow export metadata to manifest file.
-
Improve
exclude
logic to help avoidPathTooLongException
. (#156) -
Provide with a config file named
search-stopwords.json
to customise full-text search stop-words. (#279) -
Bug fixes:
-
Fix bug when cref contains loop. (#289)
-
Make sure id is unique for each HTML in markdown transforming. (#224)
-
Fix index range bugs in
YamlHeaderParser
. (#265)
Version 1.8.4
- Fix bug when outputFolder, basedirectory and destination are all not set
- fix
<a>
tag when href has invalid value with anchor
Version 1.8.3
- Fix bug for [!include()[]] when multiple articles in different subfolder including one file that v1.8.2 not resolved
Version 1.8.2
- Fix bug for [!include()[]] when multiple articles in different subfolder including one file
Version 1.8.1
- Fix bug when serialize attribute argument for type array. (#280)
- Fix bug when include file link to an anchor.
- Don't modify link when target file not existed.
Version 1.9.0-alpha-0091-g1c1b291
Support .NET Command Line Interface Project
Version 1.8
- Support multiple regions selection, code lines highlight and dedent length setting in Code Snippet. (#189)
- Support more tags in triple-slash-comments, e.g.
lang
,list
,code
,paramref
andtypeparamref
. - Add Example section to default template.
- Bug fixes:
Version 1.7.2
- Fix markdown bug:
- Ordered list continue with unordered list.
- Support gfm comments.
Version 1.7.1
- Fix markdown bug:
- Do NOT apply inline rule for html code.
- Update em rule for gfm.
Version 1.7
- Behavior change
- 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.
- Provide more information for API reference documentation
- Cross-reference is now supporting anchor
#
(#190) - C# Code snippet now supports referencing source code using a region
#engion
(#160) - Support TOC reference. With this syntax, we can combine multiple TOC files into a single TOC. (#161)
- Improve user experience when using
docfx.msbuild
in VS IDE - Code refactor:
- We improved DocFX project structure in this release.
Microsoft.DocAsCode.EntityModel
namespace is no longer in use. Assemblies are separated intoMicrosoft.DocAsCode.Build
,Microsoft.DocAsCode.DataContracts
, andMicrosoft.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.
- We improved DocFX project structure in this release.