|
7 | 7 | namespace Docfx;
|
8 | 8 |
|
9 | 9 | [Description("Generate client-only website combining API in YAML files and conceptual files")]
|
10 |
| -internal class BuildCommandOptions : LogOptions |
| 10 | +internal class BuildCommandOptions : DefaultBuildCommandOptions |
11 | 11 | {
|
12 |
| - [Description("Specify the output base directory")] |
13 |
| - [CommandOption("-o|--output")] |
14 |
| - public string OutputFolder { get; set; } |
15 |
| - |
16 |
| - [Description("Path to docfx.json")] |
17 |
| - [CommandArgument(0, "[config]")] |
18 |
| - public string ConfigFile { get; set; } |
19 |
| - |
20 |
| - [Description("Specify a list of global metadata in key value pairs (e.g. --metadata _appTitle=\"My App\" --metadata _disableContribution)")] |
21 |
| - [CommandOption("-m|--metadata")] |
22 |
| - public string[] Metadata { get; set; } |
23 |
| - |
24 |
| - [Description("Specify the urls of xrefmap used by content files.")] |
25 |
| - [CommandOption("-x|--xref")] |
26 |
| - [TypeConverter(typeof(ArrayOptionConverter))] |
27 |
| - public IEnumerable<string> XRefMaps { get; set; } |
28 |
| - |
29 |
| - [Description("Specify the template name to apply to. If not specified, output YAML file will not be transformed.")] |
30 |
| - [CommandOption("-t|--template")] |
31 |
| - [TypeConverter(typeof(ArrayOptionConverter))] |
32 |
| - public IEnumerable<string> Templates { get; set; } |
33 |
| - |
34 |
| - [Description("Specify which theme to use. By default 'default' theme is offered.")] |
35 |
| - [CommandOption("--theme")] |
36 |
| - [TypeConverter(typeof(ArrayOptionConverter))] |
37 |
| - public IEnumerable<string> Themes { get; set; } |
38 |
| - |
39 | 12 | [Description("Host the generated documentation to a website")]
|
40 | 13 | [CommandOption("-s|--serve")]
|
41 | 14 | public bool Serve { get; set; }
|
42 | 15 |
|
43 |
| - [Description("Specify the hostname of the hosted website (e.g., 'localhost' or '*')")] |
44 |
| - [CommandOption("-n|--hostname")] |
45 |
| - public string Host { get; set; } |
46 |
| - |
47 |
| - [Description("Specify the port of the hosted website")] |
48 |
| - [CommandOption("-p|--port")] |
49 |
| - public int? Port { get; set; } |
50 |
| - |
51 | 16 | [Description("Open a web browser when the hosted website starts.")]
|
52 | 17 | [CommandOption("--open-browser")]
|
53 | 18 | public bool OpenBrowser { get; set; }
|
54 |
| - |
55 |
| - [Description("Open a file in a web browser when the hosted website starts.")] |
56 |
| - [CommandOption("--open-file <RELATIVE_PATH>")] |
57 |
| - public string OpenFile { get; set; } |
58 |
| - |
59 |
| - [Description("Run in debug mode. With debug mode, raw model and view model will be exported automatically when it encounters error when applying templates. If not specified, it is false.")] |
60 |
| - [CommandOption("--debug")] |
61 |
| - public bool EnableDebugMode { get; set; } |
62 |
| - |
63 |
| - [Description("The output folder for files generated for debugging purpose when in debug mode. If not specified, it is ${TempPath}/docfx")] |
64 |
| - [CommandOption("--debugOutput")] |
65 |
| - public string OutputFolderForDebugFiles { get; set; } |
66 |
| - |
67 |
| - [Description("If set to true, data model to run template script will be extracted in .raw.model.json extension")] |
68 |
| - [CommandOption("--exportRawModel")] |
69 |
| - public bool ExportRawModel { get; set; } |
70 |
| - |
71 |
| - [Description("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")] |
72 |
| - [CommandOption("--rawModelOutputFolder")] |
73 |
| - public string RawModelOutputFolder { get; set; } |
74 |
| - |
75 |
| - [Description("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")] |
76 |
| - [CommandOption("--viewModelOutputFolder")] |
77 |
| - public string ViewModelOutputFolder { get; set; } |
78 |
| - |
79 |
| - [Description("If set to true, data model to apply template will be extracted in .view.model.json extension")] |
80 |
| - [CommandOption("--exportViewModel")] |
81 |
| - public bool ExportViewModel { get; set; } |
82 |
| - |
83 |
| - [Description("If set to true, template will not be actually applied to the documents. This option is always used with --exportRawModel or --exportViewModel is set so that only raw model files or view model files are generated.")] |
84 |
| - [CommandOption("--dryRun")] |
85 |
| - public bool DryRun { get; set; } |
86 |
| - |
87 |
| - [Description("Set the max parallelism, 0 is auto.")] |
88 |
| - [CommandOption("--maxParallelism")] |
89 |
| - public int? MaxParallelism { get; set; } |
90 |
| - |
91 |
| - [Description("Set the parameters for markdown engine, value should be a JSON string.")] |
92 |
| - [CommandOption("--markdownEngineProperties")] |
93 |
| - public string MarkdownEngineProperties { get; set; } |
94 |
| - |
95 |
| - [Description("Set the order of post processors in plugins")] |
96 |
| - [CommandOption("--postProcessors")] |
97 |
| - [TypeConverter(typeof(ArrayOptionConverter))] |
98 |
| - public IEnumerable<string> PostProcessors { get; set; } |
99 |
| - |
100 |
| - [Description("Disable fetching Git related information for articles. By default it is enabled and may have side effect on performance when the repo is large.")] |
101 |
| - [CommandOption("--disableGitFeatures")] |
102 |
| - public bool DisableGitFeatures { get; set; } |
103 | 19 | }
|
0 commit comments