Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for docfx environment variables #9020

Merged
merged 1 commit into from
Jul 28, 2023
Merged

Add docs for docfx environment variables #9020

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/docs/toc.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
29 changes: 29 additions & 0 deletions docs/reference/docfx-environment-variables-reference.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.