Releases: dotnet/docfx
Releases · dotnet/docfx
Version 1.6.1
v1.6.1
- Fix bug: "Improve this doc" button disppears in method level
v1.6
- Add attribute in c# and vb syntax.
- Support full text search, with pure client side implementation:
- The feature is disabled by default. You can enable it by adding
"_enableSearch": true
to theglobalMetadata
property ofdocfx.json
. - The search engine is powered by lunr.js
- The feature is disabled by default. You can enable it by adding
Version 1.5.2
Revert breaking changes in template introduced in v1.5.1
Version 1.5.1
- Improve
docfx init
- Fix #145
- Fix multi-threading issue when applying template
- Fix list behavior in markdown syntax to be consistent with GFM
Version 1.5
- Add 3 options to
build
subcommand:--rawModelOutputFolder
: to specify the output folder for raw model if--exportRawModel
. If the value is not set, raw model will be in the same folder as the output documenation.--viewModelOutputFolder
: to specify the output folder for view model if--exportViewModel
. If the value is not set, view model will be in the same folder as the output documenation.--dryRun
: if this option is set,docfx
will go through all the build processes for all the documents, however, no documentation will generated.
- Improve markdown:
- Allow paired parentheses in link target, e.g.
[text](paired(parentheses(are)supported)now "title")
.
- Allow paired parentheses in link target, e.g.
- Improve performance for document build.
- Breaking changes:
- modify interface @Microsoft.DocAsCode.Plugins.IDocumentBuildStep.
Version 1.4
- Cross-reference related:
-
Make @uid rule more strict: if
@
is not followed by'
or"
, it must be followed by word character ([a-zA-Z]
) -
Introduce new syntax for cross-reference:
- similar to autolink:
<xref:uid>
- similar to link:
[title](xref:uid)
or[title](@uid)
- similar to autolink:
-
support
uid
intoc.yml
:- uid: getting-started - uid: manual
-
support cross reference in
toc.md
# <xref:getting-started> # [Override title](@getting-started)
-
- Update yaml serializion:
Add @Microsoft.DocAsCode.YamlSerialization.ExtensibleMemberAttribute - Improve
docfx init
, now withdocfx init
, adocfx_project
seed project will will generated. - Several improvements for
default
template:- Provide properties to customize layout:
_disableNavbar
,_disableBreadcrumb
,_disableToc
,_disableAffix
,_disableContribution
,_disableFooter
- Include empty
main.css
andmain.js
tohead.tmpl.partial
partial template so that there is no need to customizehead.tmpl.partial
when you want to customize website style.
- Provide properties to customize layout:
Version 1.3.6
- Fix cross domain issue: timeout exception throws when document build takes longer than 15 minutes
- Fix docfx IOException when calling
docfx -l report.txt
Release v1.3.5
FIX Github pages compatibility issue( Github pages now disallow iframe, however the default template of docfx
uses iframe to load side toc): Update default template to use AJAX to load side toc, the original one is renamed to iframe.html
. So now we have 2 embedded template, one is default
and another is iframe.html
.
Version v1.3
docfx
improvements- Add subcommand
docfx template
. You can nowdocfx template list
anddocfx template export -A
to list and export all the embeded templates! - Add subcommand
docfx merge
. You can use this subcommand to mergeplatform
from multiple APIs with the sameuid
- Add two options to
build
subcommand,--exportRawModel
and--exportViewModel
.--exportRawModel
exports the data model to apply templates,--exportViewModel
exports the view model after running template's pre-process scripts. - Add
--globalMetadata
, and--globalMetadataFile
options tobuild
subcommand. These options allowglobalMetadata
to be loaded from command line in json format or from a JSON file. - Add
--fileMetadataFile
option tobuild
subcommand. This option allowsfileMeatdata
to be read from an external JSON file. - Support plugins. You can create your own template with a
plugins
folder, inside which, you create your own build steps. Refer to @Microsoft.DocAsCode.EntityModel.Plugins.BaseDocumentBuildStep for a sample plugin implementation.
- Add subcommand
- DFM syntax improvements
- Support note&div syntax
- Support query format in code snippet
[!code-<language>[<name>](<codepath><queryoption><queryoptionvalue> "<title>")]
- Change xref logic:
- If content after
@
is wrapped by'
or"
, it contains any character including white space - If content after
@
is not wrapped by'
or"
, it ends when:- line ends
- meets whitespaces
- line ends with
.
,,
,;
,:
,!
,?
and~
- meets 2 times or more
.
,,
,;
,:
,!
,?
and~
- If content after
- Code improvements
- Add @Microsoft.DocAsCode.YamlSerialization
This project is based on YamlDotNet. It overrides classes like type converters to improve performance and fix bug existed in YamlDotNet - Refactor markdown engine @Microsoft.DocAsCode.MarkdownLite
- Add @Microsoft.DocAsCode.MarkdownLite.IMarkdownRewritable`1. It provides a way to operate markdown tokens.
- Add @Microsoft.DocAsCode.YamlSerialization
- Other improvements
- Add a new property
_path
into_attrs
, it stands for the relative path fromdocfx.json
to current file - Improve missing xref warning message to include containing files.
- Add
data-uid
as attribute to generated html from default template, so that you can now finduid
for API much more easily.
- Add a new property