Add .pkgdownignore support (#2959)
#2971
Open
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
This PR adds support for a
.pkgdownignorefile that allows users to exclude specific markdown files from being rendered to HTML duringbuild_home().Fixes #2959
Motivation
With the rise of AI coding assistants, developers are increasingly adding files like
CLAUDE.md,AGENTS.md, andCOPILOT.mdto their package roots. These files are developer-facing and shouldn't appear in user documentation or site search results.Currently, there's no way to exclude arbitrary markdown files from pkgdown builds. The only options are:
Solution
A simple
.pkgdownignorefile that lists filenames to exclude:Changes
R/build-home-md.R: Added read_pkgdownignore() helper and integrated into package_mds()tests/testthat/test-pkgdownignore.R: 15 tests covering all functionalityNEWS.md: Added bullet for this featureExample
In the build output: