diff --git a/.changeset/tricky-donkeys-do.md b/.changeset/tricky-donkeys-do.md index 8859f012ba..573aa53135 100644 --- a/.changeset/tricky-donkeys-do.md +++ b/.changeset/tricky-donkeys-do.md @@ -2,4 +2,4 @@ '@techdocs/cli': minor --- -support passing additional mkdocs-server CLI parameters when run in containerized mode +support passing additional mkdocs-server CLI parameters (--dirtyreload, --strict and --clean) when run in containerized mode diff --git a/docs/features/techdocs/cli.md b/docs/features/techdocs/cli.md index e7b3aff057..97ed881922 100644 --- a/docs/features/techdocs/cli.md +++ b/docs/features/techdocs/cli.md @@ -92,7 +92,7 @@ Options: (can be added multiple times). --no-docker Do not use Docker, use MkDocs executable in current user environment. --mkdocs-parameter-clean Pass "--clean" parameter to mkdocs server running in containerized environment. - --mkdocs-parameter-dirty Pass "--dirty" parameter to mkdocs server running in containerized environment. + --mkdocs-parameter-dirtyreload Pass "--dirtyreload" parameter to mkdocs server running in containerized environment. --mkdocs-parameter-strict Pass "--strict" parameter to mkdocs server running in containerized environment. --mkdocs-port Port for MkDocs server to use (default: "8000") --preview-app-bundle-path Preview documentation using a web app other than the included one. diff --git a/packages/techdocs-cli/cli-report.md b/packages/techdocs-cli/cli-report.md index 9c155473ef..c50a320868 100644 --- a/packages/techdocs-cli/cli-report.md +++ b/packages/techdocs-cli/cli-report.md @@ -108,7 +108,7 @@ Options: --preview-app-port -c, --mkdocs-config-file-name --mkdocs-parameter-clean - --mkdocs-parameter-dirty + --mkdocs-parameter-dirtyreload --mkdocs-parameter-strict -h, --help ``` diff --git a/packages/techdocs-cli/src/commands/index.ts b/packages/techdocs-cli/src/commands/index.ts index 2d5ff98e77..d7c98db37c 100644 --- a/packages/techdocs-cli/src/commands/index.ts +++ b/packages/techdocs-cli/src/commands/index.ts @@ -295,8 +295,8 @@ export function registerCommands(program: Command) { false, ) .option( - '--mkdocs-parameter-dirty', - 'Pass "--dirty" parameter to mkdocs server running in containerized environment', + '--mkdocs-parameter-dirtyreload', + 'Pass "--dirtyreload" parameter to mkdocs server running in containerized environment', false, ) .option( diff --git a/packages/techdocs-cli/src/commands/serve/serve.ts b/packages/techdocs-cli/src/commands/serve/serve.ts index 47cfbe8a22..de681c2de4 100644 --- a/packages/techdocs-cli/src/commands/serve/serve.ts +++ b/packages/techdocs-cli/src/commands/serve/serve.ts @@ -117,7 +117,7 @@ export default async function serve(opts: OptionValues) { stderrLogFunc: mkdocsLogFunc, mkdocsConfigFileName: mkdocsYmlPath, mkdocsParameterClean: opts.mkdocsParameterClean, - mkdocsParameterDirty: opts.mkdocsParameterDirty, + mkdocsParameterDirtyReload: opts.mkdocsParameterDirtyReload, mkdocsParameterStrict: opts.mkdocsParameterStrict, }); diff --git a/packages/techdocs-cli/src/lib/mkdocsServer.ts b/packages/techdocs-cli/src/lib/mkdocsServer.ts index dced19cb7a..3c7f9ea5ec 100644 --- a/packages/techdocs-cli/src/lib/mkdocsServer.ts +++ b/packages/techdocs-cli/src/lib/mkdocsServer.ts @@ -27,7 +27,7 @@ export const runMkdocsServer = async (options: { stderrLogFunc?: LogFunc; mkdocsConfigFileName?: string; mkdocsParameterClean?: boolean; - mkdocsParameterDirty?: boolean; + mkdocsParameterDirtyReload?: boolean; mkdocsParameterStrict?: boolean; }): Promise => { const port = options.port ?? '8000'; @@ -58,9 +58,9 @@ export const runMkdocsServer = async (options: { ...(options.mkdocsConfigFileName ? ['--config-file', options.mkdocsConfigFileName] : []), - ...(options.mkdocsParameterClean ? '--clean' : []), - ...(options.mkdocsParameterDirty ? '--dirty' : []), - ...(options.mkdocsParameterStrict ? '--strict' : []), + ...(options.mkdocsParameterClean ? ['--clean'] : []), + ...(options.mkdocsParameterDirtyReload ? ['--dirty'] : []), + ...(options.mkdocsParameterStrict ? ['--strict'] : []), ], { stdoutLogFunc: options.stdoutLogFunc, @@ -78,9 +78,9 @@ export const runMkdocsServer = async (options: { ...(options.mkdocsConfigFileName ? ['--config-file', options.mkdocsConfigFileName] : []), - ...(options.mkdocsParameterClean ? '--clean' : []), - ...(options.mkdocsParameterDirty ? '--dirty' : []), - ...(options.mkdocsParameterStrict ? '--strict' : []), + ...(options.mkdocsParameterClean ? ['--clean'] : []), + ...(options.mkdocsParameterDirtyReload ? ['--dirtyreload'] : []), + ...(options.mkdocsParameterStrict ? ['--strict'] : []), ], { stdoutLogFunc: options.stdoutLogFunc,