Documentation Generator

Configuration related to the behavior of the Forge documentation generator. These keys are set in [doc] section.

out

• Type: string
• Default: docs
• Environment: FOUNDRY_DOC_OUT

An output path for generated documentation.

title

• Type: string
• Default: ""
• Environment: FOUNDRY_DOC_TITLE

Title for the generated documentation.

book

• Type: string
• Default: book.toml
• Environment: FOUNDRY_DOC_BOOK

Path to user provided book.toml. It will be merged with default settings during doc generation.

homepage

• Type: string
• Default: README.md
• Environment: FOUNDRY_DOC_HOMEPAGE

Path to user provided welcome markdown. If none is provided, it defaults to README.md.

repository

• Type: string
• Default: none
• Environment: FOUNDRY_DOC_REPOSITORY

The git repository URL. Used to provide links to git source files. If missing, forge will attempt to look up the current origin url and use its value.

path

• Type: string
• Default: none
• Environment: FOUNDRY_DOC_PATH

The path to source code (e.g., tree/main/packages/contracts). Useful for monorepos or for projects with source code located in specific directories.

ignore

• Type: array of strings (patterns)
• Default: []
• Environment: FOUNDRY_DOC_IGNORE

List of files to ignore when generating documentation. This is a comma separated list of glob patterns.