Skip to content

Commit 4c2c106

Browse files
committed
Create dedicated html outputShortcut
1 parent 70491cc commit 4c2c106

File tree

6 files changed

+22
-7
lines changed

6 files changed

+22
-7
lines changed

src/lib/internationalization/locales/en.cts

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,10 @@ export = {
221221
"If a symbol is exported multiple times, ignore all but the first export",
222222
help_externalSymbolLinkMappings:
223223
"Define custom links for symbols not included in the documentation",
224-
help_out: "Specify the location the documentation should be written to",
224+
help_out:
225+
"Specify the location the documentation for the default output should be written to",
226+
help_html:
227+
"Specify the location where the html documentation should be written to. For the default theme, this is equivalent to the out option",
225228
help_json:
226229
"Specify the location and filename a JSON file describing the project is written to",
227230
help_pretty:

src/lib/internationalization/locales/jp.cts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -234,7 +234,9 @@ export = localeUtils.buildIncompleteTranslation({
234234
"シンボルが複数回エクスポートされた場合、最初のエクスポート以外はすべて無視されます。",
235235
help_externalSymbolLinkMappings:
236236
"ドキュメントに含まれていないシンボルのカスタムリンクを定義する",
237-
help_out: "ドキュメントを書き込む場所を指定します",
237+
help_out: "デフォルトの出力ドキュメントを保存する場所を指定してください。",
238+
help_html:
239+
"HTMLドキュメントを保存する場所を指定してください。デフォルトテーマでは、これは out オプションと同等です。",
238240
help_json:
239241
"プロジェクトを説明するJSONファイルが書き込まれる場所とファイル名を指定します",
240242
help_pretty: "出力JSONをタブでフォーマットするかどうかを指定します",

src/lib/internationalization/locales/ko.cts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,9 @@ export = localeUtils.buildIncompleteTranslation({
8686
"심볼이 여러 번 내보내진 경우 첫 번째 내보내기를 제외하고 모두 무시합니다",
8787
help_externalSymbolLinkMappings:
8888
"문서에 포함되지 않은 심볼에 대한 사용자 정의 링크를 정의합니다",
89-
help_out: "문서가 쓰여질 위치를 지정합니다",
89+
help_out: "기본 출력 문서가 작성될 위치를 지정하세요.",
90+
help_html:
91+
"HTML 문서가 작성될 위치를 지정하세요. 기본 테마의 경우, 이는 out 옵션과 동일합니다.",
9092
help_json: "프로젝트를 설명하는 JSON 파일의 위치와 파일 이름을 지정합니다",
9193
help_pretty: "출력 JSON을 탭으로 포맷팅할 지 여부를 지정합니다",
9294
help_emit:

src/lib/internationalization/locales/zh.cts

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,8 @@ export = localeUtils.buildIncompleteTranslation({
227227
help_excludeReferences:
228228
"如果一个符号被导出多次,则忽略除第一次导出之外的所有导出",
229229
help_externalSymbolLinkMappings: "为文档中未包含的符号定义自定义链接",
230-
help_out: "指定文档应写入的位置",
230+
help_out: "指定默认输出文档的保存位置。",
231+
help_html: "指定HTML文档的保存位置。对于默认主题,这相当于out选项。",
231232
help_json: "指定描述项目的 JSON 文件写入的位置和文件名",
232233
help_pretty: "指定输出 JSON 是否应使用制表符进行格式化",
233234
help_emit: "指定 TypeDoc 应发出的内容,“docs”、“both”或“none”",

src/lib/utils/options/declaration.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,8 +136,9 @@ export interface TypeDocOptionMap {
136136

137137
// Output
138138
outputs: ManuallyValidatedOption<Array<OutputSpecification>>;
139-
out: string; // shortcut for defining an output
140-
json: string; // shortcut for defining an output
139+
out: string; // default output directory
140+
html: string; // shortcut for defining html output
141+
json: string; // shortcut for defining json output
141142
pretty: boolean;
142143
emit: typeof EmitStrategy;
143144
theme: string;

src/lib/utils/options/sources/typedoc.ts

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -276,12 +276,18 @@ export function addTypeDocOptions(options: Pick<Options, "addDeclaration">) {
276276
});
277277
options.addDeclaration({
278278
name: "out",
279-
outputShortcut: "html",
280279
help: (i18n) => i18n.help_out(),
281280
type: ParameterType.Path,
282281
hint: ParameterHint.Directory,
283282
defaultValue: "./docs",
284283
});
284+
options.addDeclaration({
285+
name: "html",
286+
outputShortcut: "html",
287+
help: (i18n) => i18n.help_html(),
288+
type: ParameterType.Path,
289+
hint: ParameterHint.Directory,
290+
});
285291
options.addDeclaration({
286292
name: "json",
287293
outputShortcut: "json",

0 commit comments

Comments
 (0)