Skip to content

Output formats

If you use files with the .Rmd extension, the default output format is blogdown::html_page, which uses Pandoc to render. You may also use files with the .Rmarkdown file extension, which may be knit to .markdown files to be processed by Hugo’s markdown renderer.

html_page()
An R Markdown output format for blogdown web pages

Creating new websites & content

hugo_cmd() hugo_version() hugo_available() hugo_build() new_site() new_content() new_post() hugo_convert() hugo_server()
Run Hugo commands
install_theme()
Install a Hugo theme from Github
blogdown
The blogdown package
build_dir()
Build all Rmd files under a directory
build_site()
Build a website
bundle_site()
Convert post files to leaf bundles
check_site() check_config() check_gitignore() check_hugo() check_netlify() check_vercel() check_content()
Provide diagnostics for a website project
clean_duplicates()
Clean duplicated output files
config_Rprofile()
Create or modify the .Rprofile file for a website project
config_netlify()
Create the configuration (file) for Netlify
config_vercel()
Create the configuration file for Vercel
dep_path()
A helper function to return a dependency path name
filter_newfile() filter_timestamp() filter_md5sum()
Look for files that have been possibly modified or out-of-date
find_hugo() remove_hugo()
Find or remove the Hugo executable
find_yaml() find_tags() find_categories() count_yaml()
Find posts containing the specified metadata
html_page()
An R Markdown output format for blogdown web pages
install_hugo() update_hugo()
Install Hugo
read_toml() write_toml() toml2yaml() yaml2toml()
Read and write TOML data (Tom's Obvious Markup Language)
serve_site() stop_server()
Live preview a site
shortcode() shortcode_html() shortcodes() shortcode_open() shortcode_close()
Helper functions to write Hugo shortcodes using the R syntax

Previewing and rendering websites

serve_site() stop_server()
Live preview a site
build_site()
Build a website

Managing website configurations

config_Rprofile()
Create or modify the .Rprofile file for a website project
config_netlify()
Create the configuration (file) for Netlify
config_vercel()
Create the configuration file for Vercel

Checking blogdown projects

Working with Hugo

These functions are helpers to work with Hugo and its features.

check_site() check_config() check_gitignore() check_hugo() check_netlify() check_vercel() check_content()
Provide diagnostics for a website project
find_hugo() remove_hugo()
Find or remove the Hugo executable
install_hugo() update_hugo()
Install Hugo
hugo_cmd() hugo_version() hugo_available() hugo_build() new_site() new_content() new_post() hugo_convert() hugo_server()
Run Hugo commands
hugo_installers()
Available Hugo installers of a version
shortcode() shortcode_html() shortcodes() shortcode_open() shortcode_close()
Helper functions to write Hugo shortcodes using the R syntax
bundle_site()
Convert post files to leaf bundles
find_yaml() find_tags() find_categories() count_yaml()
Find posts containing the specified metadata
read_toml() write_toml() toml2yaml() yaml2toml()
Read and write TOML data (Tom's Obvious Markup Language)
blogdown
The blogdown package
build_dir()
Build all Rmd files under a directory
build_site()
Build a website
clean_duplicates()
Clean duplicated output files
config_Rprofile()
Create or modify the .Rprofile file for a website project
config_netlify()
Create the configuration (file) for Netlify
config_vercel()
Create the configuration file for Vercel
dep_path()
A helper function to return a dependency path name
filter_newfile() filter_timestamp() filter_md5sum()
Look for files that have been possibly modified or out-of-date
html_page()
An R Markdown output format for blogdown web pages
install_theme()
Install a Hugo theme from Github
serve_site() stop_server()
Live preview a site

Helper functions

These functions are utility functions when working with blogdown.

build_dir()
Build all Rmd files under a directory
clean_duplicates()
Clean duplicated output files
dep_path()
A helper function to return a dependency path name
filter_newfile() filter_timestamp() filter_md5sum()
Look for files that have been possibly modified or out-of-date

The blogdown package

blogdown
The blogdown package