docs: add docs for docfx environment variables (#9020)

dotnet · Jul 28, 2023 · 95c642f · 95c642f
1 parent dd59353
commit 95c642f
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 0 deletions.
diff --git 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
@@ -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.