docs: add documentation for environment variable substitution feature #3447
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Documents the
substitute-env-varssetting indocs.ymlthat allows users to inject environment variables into their documentation content at build time. This feature already exists in the Fern CLI but was not documented.Changes:
settings.substitute-env-varsdocumentation to the Settings configuration section in site-level-settings.mdxThe documentation covers:
substitute-env-vars: true)${VAR_NAME}syntax for referencing environment variables${VAR}using\$\{VAR\}Review & Testing Checklist for Human
\$\{VAR\}is correct by testing in a docs project/learn/docs/configuration/site-level-settings#settingssubstitute-env-varsworks in the previewSuggested test plan: Enable
substitute-env-vars: truein a test docs project, add${TEST_VAR}to a page, and verify it substitutes correctly duringfern docs devandfern generate --docs.Notes