Skip to content
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.

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

Update global options documentation in book #355

Open
apreshill opened this issue Jan 11, 2019 · 7 comments
Open

Update global options documentation in book #355

apreshill opened this issue Jan 11, 2019 · 7 comments

Comments

@apreshill
Copy link
Contributor

Hi @yihui,

I hope it is OK for me to place there here- I would like to update this section after our workshop next week to reflect additional global options listed here: https://github.com/rstudio/blogdown/edit/master/docs/01-introduction.Rmd.

Also, I would like to reference the usethis::edit_r_profile() function here- it alerts users to the empty line rule at the end of the file in a user-friendly way.

Again, I'm assigning this issue to myself (if that is OK with you!).

Alison

@yihui
Copy link
Member

yihui commented Jan 11, 2019

I hope it is OK for me to place there here- I would like to update this section after our workshop next week to reflect additional global options listed here: https://github.com/rstudio/blogdown/edit/master/docs/01-introduction.Rmd.

Sorry, but I didn't get it: which additional options do you want to update in Section 1.4? Note that there are more options documented in the appendix: https://bookdown.org/yihui/blogdown/more-global-options.html

Also, I would like to reference the usethis::edit_r_profile() function here- it alerts users to the empty line rule at the end of the file in a user-friendly way.

Sounds good.

Again, I'm assigning this issue to myself (if that is OK with you!).

Sure!

@apreshill
Copy link
Contributor Author

Specifically, I don't see blogdown.title_case as a global option, which I like (for the appendix).

For the main overview, I think the blogdown.new_bundle = TRUE needs to at least be mentioned- many current Hugo themes are using page bundles "out of the box" (like the Academic theme's most recent versions). New users are going to be confused by this. I realize this probably means some updates to the "Content" section as well, but I was making my notes for updates sequentially :)

@yihui
Copy link
Member

yihui commented Jan 11, 2019

WAT. I forgot to document my proudest blogdown.title_case?! Oh please feel free to add this one and other ones I forgot. You need to be terse when explaining the options in the table so the table won't be too wide in PDF.

Please feel free to improve the documentation of page bundles, too. Thanks!

BTW, we should also mention that the data/ directory is NOT for R: #356

@apreshill
Copy link
Contributor Author

Good points- I'll go through a do more thorough edit/update. Also I want to add info regarding .netlify.toml files.

@yihui
Copy link
Member

yihui commented Feb 8, 2019

Yes, netlify.toml. Absolutely.

@maelle
Copy link
Contributor

maelle commented Mar 4, 2020

Ah, I was wondering where the exhaustive list of options lived! I am thrilled to learn about blogdown.title_case!

@yihui
Copy link
Member

yihui commented Mar 4, 2020

@maelle Sorry, I didn't mean to keep this option to myself: https://github.com/rbind/yihui/blob/0d4dd3a/.Rprofile#L6-L9 It is documented on the help page ?blogdown::new_post, but it certainly deserves a paragraph or two in the blogdown book.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants