From 6fad98e8ed3c481a4135ae37301bc7718e1a1dc9 Mon Sep 17 00:00:00 2001 From: filzrev <103790468+filzrev@users.noreply.github.com> Date: Fri, 28 Jul 2023 08:52:15 +0900 Subject: [PATCH] chore: Add docs for environment variables --- docs/docs/toc.yml | 2 ++ .../docfx-environment-variables-reference.md | 29 +++++++++++++++++++ 2 files changed, 31 insertions(+) create mode 100644 docs/reference/docfx-environment-variables-reference.md diff --git a/docs/docs/toc.yml b/docs/docs/toc.yml index 410a6b9dd99..a81155d88e6 100644 --- a/docs/docs/toc.yml +++ b/docs/docs/toc.yml @@ -25,6 +25,8 @@ href: ../reference/docfx-cli-reference.md - name: Docfx.json configuration reference href: ../reference/docfx-json-reference.md +- name: Docfx environment variables reference + href: ../reference/docfx-environment-variables-reference.md - name: Links and Cross References href: ../tutorial/links_and_cross_references.md - name: Overwrite Files diff --git a/docs/reference/docfx-environment-variables-reference.md b/docs/reference/docfx-environment-variables-reference.md new file mode 100644 index 00000000000..f8fc7d69260 --- /dev/null +++ b/docs/reference/docfx-environment-variables-reference.md @@ -0,0 +1,29 @@ +--- +uid: docfx_environment_variables_reference +title: docfx environment variables reference +--- + +# Docfx environment variables + +## `DOCFX_KEEP_DEBUG_INFO` + +If set true. Keep following debug info in output HTML. +- `sourceFile` +- `sourceStartLineNumber` +- `sourceEndLineNumber` +- `jsonPath` +- `data-raw-source` +- `nocheck` + +## `DOCFX_GIT_TIMEOUT` + +Used to overide git command timeout. (Default: `10,000` [ms]) + +## `DOCFX_SOURCE_BRANCH_NAME` + +Used to override git branch name. + +## `DOCFX_NO_CHECK_CERTIFICATE_REVOCATION_LIST` + +Used to disable CRL check. +This setting is intended to be used on offline environment.