Table of Contents

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_SOURCE_BRANCH_NAME

Used to override git branch name.

DOCFX_SOURCE_REPOSITORY_URL

Used to override git organization and repository names. It must be defined in the https://{host_name}/{organization}/{repository_name} format (e.g.https://github.com/dotnet/docfx).

DOCFX_NO_CHECK_CERTIFICATE_REVOCATION_LIST

Used to disable CRL check. This setting is intended to be used on offline environment.

DOCFX_PDF_TIMEOUT

Maximum time in milliseconds to override the default Playwright timeout for PDF generation.

PLAYWRIGHT_NODEJS_PATH

Custom Node.js executable path that will be used by the docfx pdf command. By default, docfx automatically detect installed Node.js from PATH.

Edit this page