Add a pkgdown build helper that drops internal-markdown pages#103
Merged
Conversation
pkgdown renders every root-level *.md into a page and does not consult .Rbuildignore, so a bare build_site() publishes an internal file such as CLAUDE.md as docs/CLAUDE.html. pkgdown has no option to exclude a root .md, so tools/build-site.R builds the site and then removes any page generated from an .Rbuildignore'd root .md. Ignore tools/ from the build.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Problem
pkgdown renders every root-level
*.mdinto a site page (all except README/LICENSE/NEWS and a couple of hardcoded templates) and it does not consult.Rbuildignore. So a barepkgdown::build_site()publishes the internalCLAUDE.mdasdocs/CLAUDE.html. pkgdown provides no option to exclude a root.md.Fix
tools/build-site.Ris the canonical pkgdown build: it runsbuild_site()and then removes any page generated from an.Rbuildignored root.md(currentlyCLAUDE.md). Fully general — it derives the internal set from.Rbuildignore, so any future internal.md(e.g.TODO.md) is handled automatically.tools/is added to.Rbuildignoreso the helper never ships in the package tarball.Verified: after
Rscript tools/build-site.R,docs/CLAUDE.htmlis gone and the real pages (home, reference, both articles, news) remain;R CMD buildexcludestools/.