You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/reference/docfx-json-reference.md
+41-17Lines changed: 41 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -71,6 +71,20 @@ Specifies an array of resource files to include in the project. Supports [File M
71
71
72
72
Contains all the conceptual files that contain yaml headers with `uid` values and is intended to override the existing metadata `yml` files. Supports [File Mappings](#file-mappings).
73
73
74
+
### `xref`
75
+
76
+
Specifies the urls of xrefmap used by content files. Currently, it supports following scheme: http, https, file.
77
+
78
+
### `dest`
79
+
80
+
Specifies the output folder of the generated metadata files relative to `docfx.json` directory.
81
+
Command line --output argument prepends this value.
82
+
83
+
### `output`
84
+
85
+
Defines the output folder of the generated build files.
86
+
Command line --output argument override this value.
87
+
74
88
### `globalMetadata`
75
89
76
90
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.
@@ -88,6 +102,17 @@ Contains metadata that will be applied to every file, in key-value pair format.
88
102
89
103
See [Predefined Metadata](#predefined-metadata) section for a list of predefined metadata.
90
104
105
+
### `globalMetadataFiles`
106
+
107
+
Set [`globalMetadata`](#globalmetadata) from external files.
@@ -170,9 +184,19 @@ The themes applied to the documentation. Theme is used to customize the styles g
170
184
171
185
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`.
172
186
173
-
### `xref`
187
+
### `postProcessors`
174
188
175
-
Specifies the urls of xrefmap used by content files. Currently, it supports following scheme: http, https, file.
189
+
Specify PostProcessor array.
190
+
Built-in HtmlProcessor is automatically added by default.
191
+
192
+
### `debug`
193
+
194
+
Run in debug mode. With debug mode, raw model and view model will be exported
195
+
automatically when it encounters error when applying templates.
196
+
197
+
### `debugOutput`
198
+
199
+
The output folder for files generated for debugging purpose when in debug mode.
176
200
177
201
### `exportRawModel`
178
202
@@ -360,7 +384,7 @@ If set to true, DocFX would not render triple-slash-comments in source code as m
360
384
### `references`
361
385
362
386
Specify additinal assembly reference files.
363
-
This settings is used when generating metadata from DLLs or source files.
387
+
This setting is used when generating metadata from DLLs or source files.
364
388
Solution or project file-based metadata generation does not use this property.
365
389
366
390
### `filter`
@@ -414,7 +438,7 @@ Specifies how categories in TOC are organized:
414
438
415
439
-`flattened` (default): Renders the namespaces as a plain label.
416
440
-`nested`: Renders the categories in a nested tree form.
417
-
-`none`: Don't render categoriy labels.
441
+
-`none`: Don't render category labels.
418
442
419
443
> [!NOTE]
420
444
> This setting is valid when using `apiPage` or `markdown` output format. `mref` format don't support categories.
@@ -499,8 +523,8 @@ The folder name for the generated files.
499
523
500
524
### Glob Patterns
501
525
502
-
-`*`: Matches 0 or more charactors in a single path portion.
503
-
-`?`: Matches 1 character in a signle path portion.
526
+
-`*`: Matches 0 or more characters in a single path portion.
527
+
-`?`: Matches 1 character in a sigle path portion.
504
528
-`**`: Matches 0 or more directories and subdirectories.
505
529
-`{}`: Expands the comma-delimited sections within the braces into a set.
0 commit comments