blogdown v0.9

0

Monthly downloads

0th

Percentile

Create Blogs and Websites with R Markdown

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' (<http://jekyllrb.com>) and 'Hexo' (<https://hexo.io>).

Readme

blogdown

Build Status Coverage status Downloads from the RStudio CRAN mirror

blogdown logo

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

## Install from CRAN
install.packages('blogdown')

## Or, install from GitHub
devtools::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.

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 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:

  1. Pick a Hugo theme that you like from http://themes.gohugo.io. All you need is its Github user and repository name, to be passed to the theme argument of new_site().
  2. Add more content (pages or posts), or migrate your existing website.

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 tag.

Functions in blogdown

Name Description
shortcode Helper functions to write Hugo shortcodes using the R syntax
html_page An R Markdown output format for blogdown web pages
install_hugo Install Hugo
hugo_cmd Run Hugo commands
blogdown The blogdown package
build_dir Build all Rmd files under a directory
find_yaml Find posts containing the specified metadata
build_site Build a website
install_theme Install a Hugo theme from Github
dep_path A helper function to return a dependency path name
serve_site Live preview a site
No Results!

Last month downloads

Details

Type Package
License GPL-3
LazyData true
URL https://github.com/rstudio/blogdown
BugReports https://github.com/rstudio/blogdown/issues
SystemRequirements Hugo () and Pandoc ()
RoxygenNote 6.1.0
Encoding UTF-8
NeedsCompilation no
Packaged 2018-10-23 16:09:34 UTC; yihui
Repository CRAN
Date/Publication 2018-10-23 16:20:03 UTC

Include our badge in your README

[![Rdoc](http://www.rdocumentation.org/badges/version/blogdown)](http://www.rdocumentation.org/packages/blogdown)