Write blog posts and web pages in R Markdown. This package supports the static site generator 'Hugo' (< https://gohugo.io>) best, and it also supports 'Jekyll' (< https://jekyllrb.com>) and 'Hexo' (< https://hexo.io>).
## Install from CRANinstall.packages('blogdown')## Or, install from GitHubremotes::install_github('rstudio/blogdown')
You may create a new site via the function
blogdown::new_site() under an empty directory. It will create a skeleton site, download a Hugo theme from Github, add some sample content, launch a web browser and you will see the new site. The sample blog post
hello-world.Rmd should be opened automatically, and you can edit it. The website will be automatically rebuilt and the page will be refreshed after you save the file.
If you use RStudio, you can create a new RStudio project for your website from the menu
File -> New Project -> New Directory -> Website using blogdown.
blogdown::serve_site() may be the most frequently used function in this package. It builds the website, loads it into your web browser, and automatically refreshes the browser when you update the Markdown or R Markdown files. Do not use the command line
hugo server to build or serve the site. It only understands plain Markdown files, and cannot build R Markdown.
You may not be satisfied with the default site created from
new_site(). There are two things you may want to do after your first successful experiment with blogdown:
The full documentation is the blogdown book freely available at https://bookdown.org/yihui/blogdown/. You are expected to read at least the first chapter.
You are welcome to send us feedback using Github issues or ask questions on StackOverflow with the
blogdown.filename.pre_processor, which can be a function with a single argument (the post title) that returns a pre-processed string to be used to generate the post filename. For example, if you set
options(blogdown.filename.pre_processor = function(x) stringi::stri_trans_general(x, "any-latin; nfd; [:nonspacing mark:] remove; nfc")), Cyrillic characters in a post title can be converted to ASCII, and the result string will be used for generating the post filename (thanks, @novica, #349).
relativeURLswill be set to
trueautomatically (thanks, @nwstephens, #124).
install_hugo(..., extended = TRUE)(thanks, @rgaiacs, #363).
slug field in the "New Post" RStudio addin will no longer be automatically changed if the user has manually changed it once (thanks, @eliocamp, #347).
Added multilingual support in the "New post" RStudio addin (thanks, @novica #344, @Guilz #323).
You can create a new post as the index file of a Hugo page bundle via
blogdown::new_post() or the RStudio addin "New Post" if you set
options(blogdown.new_bundle = TRUE). One benefit of using a page bundle instead of a normal page is that you can put resource files associated with the post (such as images) under the same directory of the post itself. This means you no longer have to put them under the
static/ directory, which has been quite confusing to Hugo beginners (thanks, @DavisVaughan @romainfrancois @apreshill, #351).
Added an argument
new_site() so that you can preserve the empty directories via
blogdown::new_site(empty_dirs = TRUE). By default, empty directories will be deleted when a new site is created (thanks, @apreshill, rstudio-education/arm-workshop-rsc2019#8).
Added a global option
blogdown.files_filter to allow users to decide which Rmd files to be rebuilt (this option can be set in
.Rprofile). The default filter is
blogdown:::timestamp_filter, i.e., only Rmd files which are older than their output files will be recompiled when rebuilding a site. You can set
options(blogdown.files_filter = blogdown:::md5sum_filter) to use a different filter based on MD5 checksums, i.e., only rebuild an Rmd file if its MD5 checksum has changed. The checksums of Rmd files are saved in the file
blogdown/md5sum.txt under the website root directory (thanks, @jonathan-g, #341).
new_post()has been changed from
'', which means this function will respect Hugo's default order of looking for the archetype. The
Archetypedropdown menu of the RStudio addin "New Post" was changed accordingly, and this menu will also list archetypes in themes (thanks, David Daza, https://stackoverflow.com/questions/53309582/53341795#comment93989876_53341795).
2018-07-28, the post file
2018-07-23-hello-world.mdcan be renamed to
draft: yesto YAML only when
options(blogdown.draft.output = TRUE)is set (thanks, @ConorIA, #312).
Added a new RStudio addin "Touch File" to update the modification time of a file, which can be useful when you want to force rebuilding a certain Rmd post after running
Added an RStudio addin "Quote Poem" to quote a poem using the Markdown syntax (https://yihui.name/en/2018/06/quote-poem-blogdown/).
Added a new function
shortcodes(), which is a vectorized version of
shortcode(). For example, you can embed multiple tweets (thanks, @maelle, #307).
Added an argument
build_dir() to ignore output filenames when testing if the Rmd file is newer than its possible output files. By default,
*.Rproj files are ignored (thanks, @chepec, #308).
Added a global option
options(blogdown.draft.output = TRUE) is set, a field
draft: yes will be appended to the YAML metadata of the HTML output file from an Rmd post, unless the Rmd post has already set the
draft option. This means the output files are always drafts unless you explicitly set
draft: no in the YAML metadata of Rmd posts (thanks, @mwaldstein, #305).
Applied a workaround for the bug in the
Rscript command: https://stat.ethz.ch/pipermail/r-devel/2018-April/075897.html (reported from https://stackoverflow.com/q/50077412).
The TOML metadata in new posts may fail to be converted to YAML (thanks, @apreshill, #301).
When editing the
config.toml file on Windows,
serve_site() could fail with an error message
'---did you forget a '#'? at line 1>seImpl(path.expand(input), verbose, fromFile): Unidentified trailing character' (thanks, @rhobis, #302).
title_case argument to the
new_post() function; if
TRUE, the post title will be converted to title case. See
?blogdown::new_post for details.
hostname argument to
new_site(), as a complement to the
theme argument. The default
'github.com'; if you have access to GitHub Enterprise, you can use this to specify it instead (thanks, @ijlyttle, #264).
new_post addin now lets you choose an archetype. See https://gohugo.io/content-management/archetypes/ for more details (thanks, @lcolladotor, #173).
Added a new RStudio addin (
insert_image) for inserting external images into blog posts (thanks, @lcolladotor, #269). If you use
options(blogdown.insertimage.usebaseurl = TRUE), it adds the baseurl so that RSS feeds will include the images and be properly displayed in websites such as RBloggers (#275). You will need to publish the images so that they are displayed in a local preview and will need to keep in mind some drawbacks discussed in https://github.com/rstudio/blogdown/pull/275.
theme argument of
new_site() now accepts a full URL to a theme's repository zip file. This can be used to install themes from other web-based git hosts, like GitLab and Bitbucket (thanks, @gadenbuie, #271).
You may download the zip archive or tarball of the Hugo installer from Github by yourself, and pass the path to
install_hugo() to install it, e.g.,
blogdown::install_hugo('hugo_0.38_Windows-64bit.zip') (thanks, @shrektan, #288).
kindargument (i.e., the archetype) of
new_content()now works with files that end in
.Rmarkdown. The archetype still has to end in
.mdfor Hugo to work with it (thanks, @lcolladotor, #261).
yihui/hugo-lithium-themewas renamed to
yihui/hugo-lithiutm, and the default
themeargument value was changed accordingly (thanks, @rorynolan, #291).
install_theme() may signal the error "The theme already exists" by mistake (thanks, @YizhouZheng, #230).
A warning will be issued if two versions of Hugo are found (thanks, @mingsnu, #235).
Plots are missing if a post filename contains multibyte characters (thanks, @dongzhuoer, #233).
serve_site() failed to parse
baseurl in config.toml when it contains comments (thanks, @ummel, https://github.com/rbind/support/issues/62).
Three dashes in the beginning and/or end of config.yaml are ignored (thanks, @andrewheiss, #194).
The R startup profile
.Rprofile under the website project root directory should be respected when building R Markdown posts (thanks, @eisioriginal, #222).