Static site generator for .NET API documentation.
MIT License
Bot releases are visible (Hide)
Published by vicancy over 8 years ago
docfx init
Published by vicancy over 8 years ago
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.[text](paired(parentheses(are)supported)now "title")
.Published by vicancy over 8 years ago
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:
<xref:uid>
[title](xref:uid)
or [title](@uid)
support uid
in toc.yml
:
- uid: getting-started
- uid: manual
support cross reference in toc.md
# <xref:getting-started>
# [Override title](@getting-started)
docfx init
, now with docfx init
, a docfx_project
seed project will will generated.default
template:
_disableNavbar
, _disableBreadcrumb
, _disableToc
, _disableAffix
, _disableContribution
, _disableFooter
main.css
and main.js
to head.tmpl.partial
partial template so that there is no need to customize head.tmpl.partial
when you want to customize website style.Published by vicancy almost 9 years ago
docfx -l report.txt
Published by vicancy almost 9 years ago
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
.
Published by vicancy almost 9 years ago
docfx
improvements
docfx template
. You can now docfx template list
and docfx template export -A
to list and export all the embeded templates!docfx merge
. You can use this subcommand to merge platform
from multiple APIs with the same uid
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.--globalMetadata
, and --globalMetadataFile
options to build
subcommand. These options allow globalMetadata
to be loaded from command line in json format or from a JSON file.--fileMetadataFile
option to build
subcommand. This option allows fileMeatdata
to be read from an external JSON file.plugins
folder, inside which, you create your own build steps. Refer to @Microsoft.DocAsCode.EntityModel.Plugins.BaseDocumentBuildStep for a sample plugin implementation.[!code-<language>[<name>](<codepath><queryoption><queryoptionvalue> "<title>")]
@
is wrapped by '
or "
, it contains any character including white space@
is not wrapped by '
or "
, it ends when:
.
, ,
, ;
, :
, !
, ?
and ~
.
, ,
, ;
, :
, !
, ?
and ~
_path
into _attrs
, it stands for the relative path from docfx.json
to current filedata-uid
as attribute to generated html from default template, so that you can now find uid
for API much more easily.