Doc-as-code: `docfx.exe` User Manual

0. Introduction

docfx.exe is used to generate documentation for programs. It has the ability to:

Extract language metadata for programing languages as defined in Metadata Format Specification. Currently language VB and CSharp are supported. The language metadata will be saved with YAML format as described in YAML 1.2.
Look for available conceptual files as provided and link it with existing programs with syntax described in Section 3. Work with Metadata in Markdown. Supported conceptual files are plain text files, html files, and markdown files.
Generate documentation to

a. Visualize language metadata, with extra content provided by linked conceptual files using syntax described in Section 3. Work with Metadata in Markdown.

b. Organize and render available conceptual files. It can be easily cross-referenced with language metadata pages. We support Docfx Flavored Markdown(DFM) for writing conceptual files. DFM supports all Github Flavored Markdown(GFM) syntax with 2 exceptions when resolving list. It also adds several new features including file inclusion, cross reference, and yaml header. For detailed description about DFM, please refer to DFM.

Currently generating documentations to a client only website is supported. The generated website can be easily published to whatever platform such as Github Pages and Azure Website with no extra effort.

Offline documentations such as pdf are planned to be supported in the future.

1. Syntax

docfx <command> [<args>]

2. Commands

2.0 Init command `docfx init`

docfx init helps generate an docfx.json file.

2.1 Help command `docfx help`

docfx help -a list available subcommands.

docfx help <command> to read about a specific subcommand

2.2 Extract language metadata command `docfx metadata`

Syntax

docfx metadata [<projects>]

Layout

|-- <metadata folder>
      |-- api
      |     |-- <namespace>.yml
      |     |-- <class>.yml
      |-- toc.yml
      |-- index.yml

2.2.1 Optional `<projects>` argument

<projects> specifies the projects to have metadata extracted. There are several approaches to extract language metadata.

From a supported project file or project file list Supported project file extensions include .csproj, .vbproj, .sln, and project.json.

Files can be combined using , as separator, e.g. docfx metadata a.csproj,b.sln.

From a supported source code file or source code file list Supported source code file extensions include .cs and .vb. Files can be combined using , as separator and search pattern.
From docfx.json file, as described in Section3.
If the argument is not specified, docfx.exe will try reading docfx.json under current directory.

The default output folder is _site/ folder if it is not specified in docfx.json under current directory.

2.2.2 Command option `--shouldSkipMarkup`

If adding option --shouldSkipMarkup in metadata command, it means that DocFX would not render triple-slash-comments in source code as markdown.

e.g. docfx metadata --shouldSkipMarkup

2.3 Generate documentation command `docfx build`

Syntax

docfx build [-o:<output_path>] [-t:<template folder>]

docfx build generates documentation for current folder.

If toc.yml or toc.md is found in current folder, it will be rendered as the top level TABLE-OF-CONTENT. As in website, it will be rendered as the top navigation bar.

Note

Please note that homepage is not supported in toc.md. And if href is referencing to a folder, it must end with /.

toc.yml syntax toc.yml is an array of items. Each item can have following properties:

Property	Description
name	Requried. The title of the navigation page.
href	Required. Can be a folder or a file UNDER current folder. Folder must be end with `/`. If is a folder, TOC.md inside the folder will be rendered as second level TABLE-OF-CONTENT. As in website, it will be rendered as sidebar.
homepage	The default content shown when no article is selected.

TOC.yml Sample

- name: Home
  href: articles/Home.md
- name: Roslyn Wiki
  href: roslyn_wiki/
- name: Roslyn API
  href: api_roslyn/
  homepage: homepages/roslyn_language_features.md

TOC.md Sample

## [Home](articles/Home.md)
## [Roslyn Wiki](roslyn_wiki/)
## [Roslyn API](api_roslyn/)

2.3.1 Optional `<output_path>` argument

The default output folder is _site/ folder

2.3.2 Optional `<template folder>` argument

If specified, use the template from template folder

Template Folder Structure

|-- <template folder>
      |-- index.html
      |-- styles
      |     |-- docascode.css
      |     |-- docascode.js
      |-- template
      |     |-- toc.html
      |     |-- navbar.html
      |     |-- yamlContent.html
      |-- favicon.ico
      |-- logo.ico

3. `docfx.json` Format

Top level docfx.json structure is key-value pair. key is the name of the subcommand, current supported subcommands are metadata and build.

3.1 Properties for `metadata`

Metadata section defines an array of source projects and their output folder. Each item has src and dest property. src defines the source projects to have metadata generated, which is in File Mapping Format. Detailed syntax is described in 4. Supported name-files File Mapping Format below. dest defines the output folder of the generated metadata files.

Key	Description
src	Defines the source projects to have metadata generated, which is in `File Mapping Format`.
dest	Defines the output folder of the generated metadata files.
force	If set to true, it would disable incremental build.
shouldSkipMarkup	If set to true, DocFX would not render triple-slash-comments in source code as markdown.
filter	Defines the filter configuration file, please go to How to filter out unwanted apis attributes for more details.
useCompatibilityFileName	If set to true, DocFX would keep ` in comment id instead of replacing it with `-`.

Sample

{
  "metadata": [
    {
      "src": [
        {
          "files": ["**/*.csproj"],
          "exclude": [ "**/bin/**", "**/obj/**" ], 
          "src": "../src"
        }
      ],
      "dest": "obj/docfx/api/dotnet",
      "shouldSkipMarkup": true
    },
    {
      "src": [
        {
          "files": ["**/*.js"],
          "src": "../src"
        }
      ],
      "dest": "obj/docfx/api/js",
      "useCompatibilityFileName": true
    }
  ]
}

3.2 Properties for `build`

Key	Description
content	Contains all the files to generate documentation, including metadata `yml` files and conceptual `md` files. `name-files` file mapping with several ways to define it, as to be described in Section4. The `files` contains all the project files to have API generated.
resource	Contains all the resource files that conceptual and metadata files dependent on, e.g. image files. `name-files` file mapping with several ways to define it, as to be described in Section4.
overwrite	Contains all the conceputal files which contains yaml header with `uid` and is intended to override the existing metadata `yml` files. `name-files` file mapping with several ways to define it, as to be described in Section4.
globalMetadata	Contains metadata that will be applied to every file, in key-value pair format. For example, you can define `"_appTitle": "This is the title"` in this section, and when applying template `default`, it will be part of the page title as defined in the template.
fileMetadata	Contains metadata that will be applied to specific files. `name-files` file mapping with several ways to define it, as to be described in Section4.
~~globalMetadataFile~~	Obsoleted, Specify a JSON file path containing globalMetadata settings, as similar to `{"globalMetadata":{"key":"value"}}`.
globalMetadataFiles	Specify a list of JSON file path containing globalMetadata settings, as similar to `{"key":"value"}`. Please read Section3.2.3 for detail.
~~fileMetadataFile~~	Obsoleted, Specify a JSON file path containing fileMetadata settings, as similar to `{"fileMetadata":{"key":"value"}}`.
fileMetadataFiles	Specify a list of JSON file path containing fileMetadata settings, as similar to `{"key":"value"}`. Please read Section3.2.3 for detail.
template	The templates applied to each file in the documentation. It can be a string or an array. The latter ones will override the former ones if the name of the file inside the template collides. If ommited, embedded `default` template will be used.
theme	The themes applied to the documentation. Theme is used to customize the styles generated by `template`. It can be a string or an array. The latter ones will override the former ones if the name of the file inside the template collides. If ommited, no theme will be applied, the default theme inside the template will be used.
~~externalReferences~~	Obsoleted, Contains `rpk` files that define the external references. `name-files` file mapping with several ways to define it, as to be described in Section4.
xref	Specifies the urls of xrefmap used by content files. Currently, it supports following scheme: http, https, ftp, file, embedded.
exportRawModel	If set to true, data model to run template script will be extracted in `.raw.json` extension.
rawModelOutputFolder	Specify the output folder for the raw model. If not set, the raw model will be generated to the same folder as the output documentation.
exportViewModel	If set to true, data model to apply template will be extracted in `.view.json` extension.
viewModelOutputFolder	Specify the output folder for the view model. If not set, the view model will be generated to the same folder as the output documentation.
dryRun	If set to true, template will not be actually applied to the documents. This option is always used with `--exportRawModel` or `--exportViewModel`, so that only raw model files or view model files are generated.
maxParallelism	Set the max parallelism, 0 (default) is same as the count of CPU cores.
markdownEngineName	Set the name of markdown engine, default is `dfm`, and another build-in engine is `gfm`.
markdownEngineProperties	Set the parameters for markdown engine, value should be a JSON string.
noLangKeyword	Disable default lang keyword, it can be downloaded from here.

3.2.1 `Template`s and `Theme`s

Templates are used to transform YAML files generated by docfx to human-readable pages. A page can be a markdown file, a html file or even a plain text file. Each YAML file will be transformed to ONE page and be exported to the output folder preserving its relative path to src. For example, if pages are in HTML format, a static website will be generated in the output folder.

Theme is to provide general styles for all the generated pages. Files inside a theme will be generally COPIED to the output folder. A typical usage is, after YAML files are transformed to HTML pages, well-designed CSS style files in a Theme can then overwrite the default styles defined in template, e.g. main.css.

There are two ways to use custom templates and themes.

To use a custom template, one way is to specify template path with --template (or -t) command option, multiple templates must be separated by , with no spaces. The other way is to set key-value mapping in docfx.json:

{
  ...
  { 
    "build" : 
    {
      ...
      "template": "custom",
      ...
    }
  ... 
}

{
  ...
  { 
    "build" : 
    {
      ...
      "template": ["default", "X:/template/custom"],
      ...
    }
  ... 
}

Note

The template path could either be a zip file called <template>.zip or a folder called <template>.

Warning

DocFX has embedded templates: default, iframe.html, statictoc and common. Please avoid using these as template folder name.

To custom theme, one way is to specify theme name with --theme command option, multiple themes must be separated by , with no spaces. The other way is to set key-value mapping in docfx.json as similar to defining template. Also, both .zip file and folder are supported.

Please refer to How to Create Custom Templates to create custom templates.

Sample

{
  "build": {
    "content":
      [
        {
          "files": ["**/*.yml"],
          "src": "obj/docfx"
        },
        {
          "files": ["tutorial/**/*.md", "spec/**/*.md", "spec/**/toc.yml"]
        },
        {
          "files": ["toc.yml"]
        }
      ],
    "resource": [
        {
          "files": ["spec/images/**"]
        }
    ],
    "overwrite": "apispec/*.md",
    "externalReference": [
    ],
    "globalMetadata": {
      "_appTitle": "DocFX website"
    },
    "dest": "_site",
    "template": "default"
  }
}

3.2.2 Reserved Metadata

After passing values through global metadata or file metadata, DocFX can use these metadata in templates to control the output html. Reserved metadatas:

Metadata Name	Type	Description
_appTitle	string	Will be appended to each output page's head title.
_appFooter	string	The footer text. Will show DocFX's Copyright text if not specified.
_appLogoPath	string	Logo file's path from output root. Will show DocFX's logo if not specified. Remember to add file to resource.
_appFaviconPath	string	Favicon file's path from output root. Will show DocFX's favicon if not specified. Remember to add file to resource.
_enableSearch	bool	Indicate whether to show the search box on the top of page.
_enableNewTab	bool	Indicate whether to open a new tab when clicking an external link. (internal link always shows within the current tab)
_disableNavbar	bool	Indicate whether to show the navigation bar on the top of page.
_disableBreadcrumb	bool	Indicate whether to show breadcrumb on the top of page.
_disableToc	bool	Indicate whether to show table of contents on the left of page.
_disableAffix	bool	Indicate whether to show the affix bar on the right of page.
_disableContribution	bool	Indicate whether to show the `View Source` and `Improve this Doc` buttons.
_gitContribute	object	Customize the `Improve this Doc` URL button for public contributors. Use `repo` to specify the contribution repository URL. Use `branch` to specify the contribution branch. Use `path` to specify the folder for new overwrite files. If not set, the git URL and branch of the current git repository will be used.
_gitUrlPattern	string	Choose the URL pattern of the generated link for `View Source` and `Improve this Doc`. Supports `github` and `vso` currently. If not set, DocFX will try speculating the pattern from domain name of the git URL.

3.2.3 Separated metadata files for global metadata and file metadata

There're three ways to set metadata for a file in DocFX:

using global metadata, it will set metadata for every file.
using file metadata, it will set metadata for files that match pattern.
using YAML header, it will set metadata for current file.

In above ways, the later way will always overwrite the former way if the same key of metadata is set.

Here we will show you how to set global metadata and file metadata using separated metadata files. Take global metadata for example, you can set globalMetadataFiles in docfx.json or --globalMetadataFiles in build command line. The usage of fileMetadataFiles is the same as globalMetadataFiles.

There're some metadata file examples:

globalMetadata file example

  {
      "_appTitle": "DocFX website",
      "_enableSearch": "true"
  }

fileMetadata file example

  {
      "priority": {
          "**.md": 2.5,
          "spec/**.md": 3
      },
      "keywords": {
          "obj/docfx/**": ["API", "Reference"],
          "spec/**.md": ["Spec", "Conceptual"]
      }
  }

There're some examples about how to use separated metadata files.

use globalMetadataFiles in docfx.json

  ...
  "globalMetadataFiles": ["global1.json", "global2.json"],
  ...

use --globalMetadataFiles in build command line

  docfx build --globalMetadataFiles global1.json,global2.json

use fileMetadataFiles in docfx.json

  ...
  "fileMetadataFiles": ["file1.json", "file2.json"],
  ...

use --fileMetadataFiles in build command line

  docfx build --fileMetadataFiles file1.json,file2.json

Note that, metadata set in command line will merge with metadata set in docfx.json.

If same key for global metadata was set, the order to be overwritten would be(the later one will overwrite the former one):
1. global metadata from docfx config file
2. global metadata from global metadata files
3. global metadata from command line
If same file pattern for file metadata was set, the order to be overwritten would be(the later one will overwrite the former one):
1. file metadata from docfx config file
2. file metadata from file metadata files

Given multiple metadata files, the behavior would be undetermined, if same key is set in these files.

4. Supported File Mapping Format

There are several ways to define file mapping.

4.1 Array Format

This form supports multiple file mappings, and also allows additional properties per mapping. Supported properties:

Property Name	Description
files	REQUIRED. The file or file array, `glob` pattern is supported.
~~name~~	Obsoleted, please use `dest`.
exclude	The files to be excluded, `glob` pattern is supported.
~~cwd~~	Obsoleted, please use `src`.
src	Specifies the source directory. If omitted, the directory of the config file will be used. Use this option when you want to refer to files in relative folders while want to keep folder structure. e.g. set `src` to `..`.
dest	The folder name for the generated files.
version	Version name for the current file mapping. If not set, treat the current file-mapping item as in default version. Mappings with the same version name will be built together. Cross reference doesn't support cross different versions.
caseSensitive	TOBEIMPLEMENTED. Default value is `false`. If set to `true`, the glob pattern is case sensitive. e.g. `*.txt` will not match `1.TXT`. For OS Windows, file path is case insensitive while for Linux/Unix, file path is case sensitive. This option offers user the flexibility to determine how to search files.
supportBackslash	TOBEIMPLEMENTED. Default value is `true`. If set to `true`, `\` will be considered as file path separator. Otherwise, `\` will be considered as normal character if `escape` is set to `true` and as escape character if `escape` is set to `false`. If `escape` is set to `true`, `\\` should be used to represent file path separator.
escape	TOBEIMPLEMENTED. Default value is `false`. If set to `true`, `\` character is used as escape character, e.g. `\{\}.txt` will match `{}.txt`.

"key": [
  {"files": ["file1", "file2"], "dest": "dest1"},
  {"files": "file3", "dest": "dest2"},
  {"files": ["file4", "file5"], "exclude": ["file5"], "src": "folder1"},
  {"files": "Example.yml", "src": "v1.0", "dest":"v1.0/api", "version": "v1.0"},
  {"files": "Example.yml", "src": "v2.0", "dest":"v2.0/api", "version": "v2.0"}
]

4.2 Compact Format

"key": ["file1", "file2"]

4.3 Glob Pattern

DocFX uses Glob to support glob pattern in file path. It offers several options to determine how to parse the Glob pattern:

caseSensitive: Default value is false. If set to true, the glob pattern is case sensitive. e.g. *.txt will not match 1.TXT. For OS Windows, file path is case insensitive while for Linux/Unix, file path is case sensitive. This option offers user the flexibility to determine how to search files.
supportBackslash: Default value is true. If set to true, \ will be considered as file path separator. Otherwise, \ will be considered as normal character if escape is set to true and as escape character if escape is set to false. If escape is set to true, \\ should be used to represent file path separator.
escape: Default value is false. If set to true, \ character is used as escape character, e.g. \{\}.txt will match {}.txt.

In general, the glob pattern contains the following rules:

* matches any number of characters, but not /
? matches a single character, but not /
** matches any number of characters, including /, as long as it's the only thing in a path part
{} allows for a comma-separated list of OR expressions

SAMPLES

5. Q & A

Do we support files outside current project folder(the folder when docfx.json exists)? A: YES. DO specify src and files outside of current folder will be copied to output folder keeping the same relative path to src.
Do we support output folder outside current project folder(the folder when docfx.json exists)? A: YES.
Do we support referencing files outside of current project folder(the folder when docfx.json exists)? A: NO.

Doc-as-code: docfx.exe User Manual

0. Introduction

1. Syntax

2. Commands

2.0 Init command docfx init

2.1 Help command docfx help

2.2 Extract language metadata command docfx metadata

2.2.1 Optional <projects> argument

2.2.2 Command option --shouldSkipMarkup

2.3 Generate documentation command docfx build

Note

2.3.1 Optional <output_path> argument

2.3.2 Optional <template folder> argument

3. docfx.json Format

3.1 Properties for metadata

3.2 Properties for build

3.2.1 Templates and Themes

Note

Warning

3.2.2 Reserved Metadata

3.2.3 Separated metadata files for global metadata and file metadata

4. Supported File Mapping Format

4.1 Array Format

4.2 Compact Format

4.3 Glob Pattern

5. Q & A

Doc-as-code: `docfx.exe` User Manual

2.0 Init command `docfx init`

2.1 Help command `docfx help`

2.2 Extract language metadata command `docfx metadata`

2.2.1 Optional `<projects>` argument

2.2.2 Command option `--shouldSkipMarkup`

2.3 Generate documentation command `docfx build`

2.3.1 Optional `<output_path>` argument

2.3.2 Optional `<template folder>` argument

3. `docfx.json` Format

3.1 Properties for `metadata`

3.2 Properties for `build`

3.2.1 `Template`s and `Theme`s