Skip to content

docs: Document AI config file exclusion (CLAUDE.md, AGENTS.md) #1852

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

Merged
cderv merged 1 commit into from
Jan 19, 2026
Merged

docs: Document AI config file exclusion (CLAUDE.md, AGENTS.md) #1852

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/extensions/starter-templates.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ To create a starter template, just create a GitHub repository that includes the

2. Common GitHub repository files like `README.md` and `LICENSE`.

3. AI assistant configuration files (`CLAUDE.md`, `AGENTS.md`).

If you'd like, you can also include a `.quartoignore` file in the root of your repository listing other files or directories you'd like to exclude. Each line of the file should be a glob describing file(s) to ignore (using syntax like a `.gitignore` file).

### template.qmd
Expand Down
2 changes: 2 additions & 0 deletions docs/projects/_render-targets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ By default, all valid Quarto input files (.qmd, .ipynb, .md, .Rmd) in the projec

3. Files named `README.md` or `README.qmd` (which are typically not actual render targets but rather informational content about the source code to be viewed in the version control web UI).

4. AI assistant configuration files (`CLAUDE.md`, `AGENTS.md`) which provide instructions for AI coding assistants and are not intended as rendered content.

If you don't want to render all of the target documents in a project, or you wish to control the order of rendering more precisely, you can add a `project: render: [files]` entry to your project metadata. For example:

``` yaml
Expand Down