I think we should always ignore files starting with _, otherwise the logic sounds too complicated to explain to users and also complicates the implementation. Thank you!

Hello,

This unfortunately breaks the recommendation of pkgdown to use underscores to cooperate with bookdown (see build_articles()). Is there still a way to include files with initial underscores?

Thanks,
Rick

@rickhelmus I don't see how it breaks the recommendation of pkgdown. The help page says:

build_articles() renders each R Markdown file underneath vignettes/ and saves it to articles/. There are two exceptions:

• Files that start with _ (e.g., _index.Rmd) are ignored, enabling the use of child documents in bookdown

• Files in vignettes/tutorials are handled by build_tutorials()

So pkgdown also ignores files that start with _, which is consistent with bookdown. If you do want to use files that start with _, you can use them as child documents of other files that do not start with _.

Hi yihui,

Thanks for your answer. I wasn't being really clear, sorry. I am actually already using one 'master' Rmd that includes several child documents. The problem is that I want to exclude this master document from pkgdown. Anyway, this may be more a feature request for pkgdown so I created a bug there.

Thanks,
Rick

@rickhelmus Okay, now I see. Sorry about the trouble! Let me think more about it.

Hi @rickhelmus ,

Just chiming in as I am trying to understand the interaction between pkgdown and bookdown in your usage.

The problem is that I want to exclude this master document from pkgdown

As you are using pkgdown, I understand your working on a package. Then, I understand that you have a bookdown project inside your package that you store in the vignette folder but you don't want to get it rendered as article in your package doc website. Correct ?
Or is is not a book project and are you just using one of the single document format (bookdown::html_document2 ?) for you master.Rmd ?

If you can provide a complete use case (maybe in a new issue) I am willing to dig into it to see what could be done on pkgdown or/and bookdown about this usage.

However, @yihui seems to have a more clearer picture than mine though, so maybe this won't be necessary 😄