Giter VIP home page Giter VIP logo

blogdown's Introduction

blogdown

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

blogdown's People

Contributors

yihui avatar proquestionasker avatar apreshill avatar lcolladotor avatar barkleybg avatar gadenbuie avatar yutannihilation avatar rpodcast avatar samuel-rosa avatar bakaniko avatar tomatoiscoding avatar cderv avatar deependrad avatar saurfang avatar ijlyttle avatar jjallaire avatar coatless avatar jonmcalder avatar kevinushey avatar m4xl1n avatar njtierney avatar rsangole avatar rgaiacs avatar rorynolan avatar tcgriffith avatar tteo avatar thanosgatos avatar timtrice avatar shrektan avatar yue-jiang avatar

Watchers

kalaokay avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.