Skip to content

Commit 860d3f8

Browse files
authored
chore: Fix config reference documentation (#10683)
chore: fix json config-reference documentation
1 parent 4438316 commit 860d3f8

File tree

2 files changed

+42
-18
lines changed

2 files changed

+42
-18
lines changed

docs/reference/docfx-json-reference.md

Lines changed: 41 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,20 @@ Specifies an array of resource files to include in the project. Supports [File M
7171

7272
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).
7373

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+
7488
### `globalMetadata`
7589

7690
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.
88102

89103
See [Predefined Metadata](#predefined-metadata) section for a list of predefined metadata.
90104

105+
### `globalMetadataFiles`
106+
107+
Set [`globalMetadata`](#globalmetadata) from external files.
108+
109+
```json
110+
{
111+
"build": {
112+
"globalMetadataFiles": ["global1.json", "global2.json"]
113+
}
114+
}
115+
```
91116
### `fileMetadata`
92117

93118
Specifies metadata associated with a particular file in order of metadata name, file [glob patterns](#glob-patterns) and metadata value:
@@ -114,17 +139,6 @@ Specifies metadata associated with a particular file in order of metadata name,
114139

115140
See [Predefined Metadata](#predefined-metadata) section for a list of predefined metadata.
116141

117-
### `globalMetadataFiles`
118-
119-
Set [`globalMetadata`](#globalmetadata) from external files.
120-
121-
```json
122-
{
123-
"build": {
124-
"globalMetadataFiles": ["global1.json", "global2.json"]
125-
}
126-
}
127-
```
128142

129143
### `fileMetadataFiles`
130144

@@ -170,9 +184,19 @@ The themes applied to the documentation. Theme is used to customize the styles g
170184

171185
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`.
172186

173-
### `xref`
187+
### `postProcessors`
174188

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.
176200

177201
### `exportRawModel`
178202

@@ -360,7 +384,7 @@ If set to true, DocFX would not render triple-slash-comments in source code as m
360384
### `references`
361385

362386
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.
364388
Solution or project file-based metadata generation does not use this property.
365389

366390
### `filter`
@@ -414,7 +438,7 @@ Specifies how categories in TOC are organized:
414438

415439
- `flattened` (default): Renders the namespaces as a plain label.
416440
- `nested`: Renders the categories in a nested tree form.
417-
- `none`: Don't render categoriy labels.
441+
- `none`: Don't render category labels.
418442

419443
> [!NOTE]
420444
> 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.
499523

500524
### Glob Patterns
501525

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.
504528
- `**`: Matches 0 or more directories and subdirectories.
505529
- `{}`: Expands the comma-delimited sections within the braces into a set.
506530

src/Docfx.Dotnet/MetadataJsonConfig.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -141,7 +141,7 @@ internal class MetadataJsonItemConfig
141141

142142
/// <summary>
143143
/// Specify additinal assembly reference files.
144-
/// This settings is used when generating metadata from DLLs or source files.
144+
/// This setting is used when generating metadata from DLLs or source files.
145145
/// Solution or project file-based metadata generation does not use this property.
146146
/// </summary>
147147
[JsonProperty("references")]

0 commit comments

Comments
 (0)