R HTML

README.md

blogdown

Build Status

A open-source (GPL-3) R package to generate static websites based on R Markdown and Hugo. You can install the package via:

devtools::install_github('rstudio/blogdown')

If you are not familiar with Hugo or the PATH variable, or do not want to read the Hugo installation instructions, you may use the helper function blogdown::install_hugo() to install Hugo.

Once you have installed Hugo, you may create a new site via 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, and generate the new site in the project (the new project will contain a *.Rproj file but that is fine).

The function 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 no use the command line hugo server to build or serve the site. It only understands plain Markdown files, and cannot build R Markdown. If you do not want serve_site() to block your R session, you can set the option options(servr.daemon = TRUE) first.

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:

  1. Pick a Hugo theme that you like from http://themes.gohugo.io. All you need is its Github user and repository name. For example, if you like the Ghostwriter theme, you can install it via blogdown::install_theme('jbub/ghostwriter') (other themes possibly of interest: simple-a, hugo-academic, hugo-future-imperfect, hugo-tranquilpeak-theme, ...).
  2. Add more content (pages or posts), or migrate your existing website.

The full documentation of this package is still under development. If you do not want to wait, you can read the Hugo documentation, which can be a little overwhelming if you have no experience with static site generators. Note although Hugo supports TOML, YAML, and JSON in the front matter of Markdown files, R Markdown only supports YAML, so you have to use YAML in *.Rmd files. Feel free to use other formats in plain Markdown files (*.md).

You are welcome to send us feedback using Github issues or ask questions on StackOverflow with the blogdown tag. Please note this package is still in a very early beta stage.