some code'
46 | x11 = ' some span'
47 |
48 | (remove_highlight_tags(x = x10) %==% ' some code')
49 | (remove_highlight_tags(x = x11) %==% ' some span')
50 |
51 | })
52 |
53 |
54 | assert('fix_img_tags() converts Learn more at 37 | [rmarkdown.rstudio.com](https://rmarkdown.rstudio.com/). 38 | 39 | # structure of website themed for R Markdown ecosystem 40 | navbar: 41 | structure: 42 | left: [intro, examples, articles, reference, news] 43 | components: 44 | examples: 45 | text: Examples 46 | href: articles/examples.html 47 | 48 | # Add articles menu using 49 | # https://pkgdown.r-lib.org/dev/reference/build_articles.html#index-and-navbar 50 | articles: 51 | - title: Get Started 52 | desc: | 53 | Start here to know how to learn **blogdown** 54 | contents: 55 | - blogdown 56 | - title: Example 57 | desc: Gallery of examples 58 | contents: 59 | - articles/examples 60 | 61 | news: 62 | releases: 63 | - text: "Version 1.6" 64 | href: https://yihui.org/en/2021/11/blogdown-v1-6/ 65 | - text: "Version 1.0" 66 | href: https://posit.co/blog/blogdown-v1-0/ 67 | - text: "Version 0.1" 68 | href: https://posit.co/blog/announcing-blogdown/ 69 | 70 | reference: 71 | - title: Output formats 72 | desc: > 73 | If you use files with the `.Rmd` extension, the default output format is 74 | `blogdown::html_page`, which uses Pandoc to render. You may also use files with the `.Rmarkdown` file extension, which 75 | may be knit to `.markdown` files to be processed by Hugo's markdown renderer. 76 | contents: 77 | - html_page 78 | 79 | - title: Creating new websites & content 80 | contents: 81 | - new_site 82 | - install_theme 83 | - new_post 84 | - new_content 85 | - -starts_with("hugo") 86 | 87 | - title: Previewing and rendering websites 88 | contents: 89 | - serve_site 90 | - build_site 91 | 92 | - title: Managing website configurations 93 | contents: 94 | - starts_with("config") 95 | 96 | - title: Checking blogdown projects 97 | contents: 98 | - starts_with("check") 99 | 100 | - title: Working with Hugo 101 | desc: > 102 | These functions are helpers to work with Hugo and its features. 103 | contents: 104 | - ends_with("hugo") 105 | - starts_with("hugo") 106 | - starts_with("shortcode") 107 | - bundle_site 108 | - find_yaml 109 | - read_toml 110 | - -starts_with("check_") 111 | 112 | - title: Helper functions 113 | desc: These functions are utility functions when working with blogdown. 114 | contents: 115 | - build_dir 116 | - clean_duplicates 117 | - dep_path 118 | - starts_with("filter") 119 | 120 | - title: The blogdown package 121 | desc: ~ 122 | contents: 123 | - blogdown-package 124 | -------------------------------------------------------------------------------- /vignettes/blogdown.Rmd: -------------------------------------------------------------------------------- 1 | --- 2 | title: "Learn blogdown" 3 | output: rmarkdown::html_vignette 4 | vignette: > 5 | %\VignetteIndexEntry{Learn blogdown} 6 | %\VignetteEngine{knitr::rmarkdown} 7 | %\VignetteEncoding{UTF-8} 8 | --- 9 | 10 | ## User Guide 11 | 12 |
13 |
14 | Written by Yihui Xie, the package author, [blogdown: Creating Websites with R Markdown](https://bookdown.org/yihui/blogdown/) introduces the R package and how to use it. The book is published by Chapman & Hall/CRC, and you can read it online for free.
15 |
16 | The book is structured into 5 parts to guide the reader into the use of the R package **blogdown** to create and manage websites:
17 |
18 | ```{r, results='asis', echo = FALSE, eval = FALSE}
19 | # run this to update the content below
20 | xfun::pkg_attach2("xml2")
21 | html <- read_html("https://bookdown.org/yihui/blogdown/")
22 | chapters <- xml_find_all(html, "//li[@class='chapter']")
23 | first_level <- chapters[which(purrr::map_lgl(xml_attr(chapters, 'data-level'), ~ grepl('^\\d+$', .x)))]
24 | titles <- xml_text(xml_find_all(first_level, "a"))
25 | titles <- gsub("^(\\d+)", "\\1.", titles)
26 | titles <- gsub("^(.*) \\([*])$", "\\1", titles)
27 | url <- file.path("https://bookdown.org/yihui/blogdown", xml_attr(first_level, "data-path"))
28 | formatted <- sprintf("* [%s](%s)", titles, url)
29 | cat(formatted, sep = "\n")
30 | ```
31 |
32 |
33 | * [1. Get Started](https://bookdown.org/yihui/blogdown/get-started.html) introduces the package and how to get started using it. This is the chapter every user is expected to read.
34 | * [2. Hugo](https://bookdown.org/yihui/blogdown/hugo.html) introduces [Hugo](https://gohugo.io), the static site generator on which blogdown is based. It will act as a guide to those who are just getting started with Hugo.
35 | * [3. Deployment](https://bookdown.org/yihui/blogdown/deployment.html) explains different methods to deploy your static website online.
36 | * [4. Migration](https://bookdown.org/yihui/blogdown/migration.html) explains how to migrate from other framework to a Hugo website.
37 | * [5. Other Generators](https://bookdown.org/yihui/blogdown/other-generators.html) explains how to use **blogdown** with a custom build method.
38 |
39 |
40 | **A note from the authors**: Some of the information and instructions in this book are now out of date because of changes to Hugo and the recent **blogdown** package. Most of the book is still valid but some chapters may have less accurate informations
41 |
42 | ## About R Markdown
43 |
44 | 
45 |
46 | If you are new to **R Markdown**, we recommend you start with [R Markdown: The Definitive Guide](https://bookdown.org/yihui/rmarkdown/) to get an overview. [Part I](https://bookdown.org/yihui/rmarkdown/installation.html) introduces how to install the relevant packages, and provides an overview of R Markdown, including the possible output formats, the Markdown syntax, the R code chunk syntax, and how to use other languages in R Markdown.
47 |
48 | Next, the chapter on [_Websites_](https://bookdown.org/yihui/rmarkdown/websites.html) will help orient you to how the **blogdown** package allows you to use R Markdown to create websites.
49 |
50 | ## Going further with examples
51 |
52 | Look at the [Examples](articles/examples.html) page.
53 |
--------------------------------------------------------------------------------
/docs/10-experience.Rmd:
--------------------------------------------------------------------------------
1 | # Personal Experience
2 |
3 | I started blogging at blogchina.com in 2005, moved to blog.com.cn, then MSN Space, and finally purchased my own domain `yihui.org` and a virtual host. I first used a PHP application named Bo-Blog, then switched to WordPress, and then Jekyll. Finally I moved to Hugo. Although I have moved several times, all my posts have been preserved, and you can still see my first post in Chinese in 2005. I often try my best not to introduce broken links (which lead to the 404 page) every time I change the backend of my website. When it is too hard to preserve the original links of certain pages, I will redirect the broken URLs to the new URLs. That is why it is important for your system to support redirections, and in particular, 301 redirections (Netlify does a nice job here). Here are some of my redirection rules: 
2 |
3 |
4 | [](https://github.com/rstudio/blogdown/actions/workflows/R-CMD-check.yaml)
5 | [](https://CRAN.R-project.org/package=blogdown)
6 | [](https://app.codecov.io/gh/rstudio/blogdown?branch=main)
7 |
8 |
9 | The goal of the blogdown package is to provide a powerful and customizable website output format for [R Markdown](https://rmarkdown.rstudio.com/). Use dynamic R Markdown documents to build webpages featuring:
10 |
11 | + R code (or other programming languages that [knitr](https://yihui.org/knitr/) supports),
12 |
13 | + automatically rendered output such as graphics, tables, analysis results, and HTML widgets, and
14 |
15 | + technical writing elements such as citations, footnotes, and LaTeX math, enabled by the [bookdown package](https://pkgs.rstudio.com/bookdown/).
16 |
17 | By default, blogdown uses [Hugo](https://gohugo.io), a popular open-source static website generator, which provides a fast and flexible way to build your site content to be shared online. Other website generators like Jekyll and Hexo are also supported.
18 |
19 | A useful feature of blogdown sites, compared to other R Markdown-based [websites](https://bookdown.org/yihui/rmarkdown/rmarkdown-site.html), is that you may organize your website content (including R Markdown files) within subdirectories. This makes blogdown a good solution not just for blogging or sites about R — it can also be used to create general-purpose websites to communicate about data science, statistics, data visualization, programming, or education.
20 |
21 | ## Book
22 |
23 |
24 |
25 | ## Installation
26 |
27 | You can install the package via CRAN as follows:
28 |
29 | ```r
30 | install.packages('blogdown')
31 | ```
32 |
33 | If you want to use the development version of the **blogdown** package, you can install the package from GitHub via the [**remotes** package](https://remotes.r-lib.org):
34 |
35 | ```r
36 | remotes::install_github('rstudio/blogdown')
37 | ```
38 | ## Usage
39 |
40 | 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.
41 |
42 | 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`.
43 |
44 | 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.
45 |
46 | 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**:
47 |
48 | 1. Pick a Hugo theme that you like from https://themes.gohugo.io. All you need is its Github user and repository name, to be passed to the `theme` argument of `new_site()`.
49 | 2. Add more content (pages or posts), or migrate your existing website.
50 |
51 | ## Getting help
52 |
53 | There are two main places to get help:
54 |
55 | 1. The [RStudio community](https://community.rstudio.com/tags/c/R-Markdown/10/blogdown) is a friendly place to ask any questions about **blogdown**. Be sure to use the `blogdown` tag.
56 |
57 | 1. [Stack Overflow](https://stackoverflow.com/questions/tagged/blogdown) is a great source of answers to common **blogdown** questions. Use the tags [`[r][blogdown]`](https://stackoverflow.com/questions/tagged/blogdown+r) if you ask a question.
58 |
59 | ## Code of Conduct
60 |
61 | Please note that the blogdown project is released with a [Contributor Code of Conduct](https://pkgs.rstudio.com/blogdown/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
62 |
--------------------------------------------------------------------------------
/pkgdown/assets/ace-1.2.3/mode-r.js:
--------------------------------------------------------------------------------
1 | ace.define("ace/mode/tex_highlight_rules",["require","exports","module","ace/lib/oop","ace/lib/lang","ace/mode/text_highlight_rules"],function(e,t,n){"use strict";var r=e("../lib/oop"),i=e("../lib/lang"),s=e("./text_highlight_rules").TextHighlightRules,o=function(e){e||(e="text"),this.$rules={start:[{token:"comment",regex:"%.*$"},{token:e,regex:"\\\\[$&%#\\{\\}]"},{token:"keyword",regex:"\\\\(?:documentclass|usepackage|newcounter|setcounter|addtocounter|value|arabic|stepcounter|newenvironment|renewenvironment|ref|vref|eqref|pageref|label|cite[a-zA-Z]*|tag|begin|end|bibitem)\\b",next:"nospell"},{token:"keyword",regex:"\\\\(?:[a-zA-z0-9]+|[^a-zA-z0-9])"},{token:"paren.keyword.operator",regex:"[[({]"},{token:"paren.keyword.operator",regex:"[\\])}]"},{token:e,regex:"\\s+"}],nospell:[{token:"comment",regex:"%.*$",next:"start"},{token:"nospell."+e,regex:"\\\\[$&%#\\{\\}]"},{token:"keyword",regex:"\\\\(?:documentclass|usepackage|newcounter|setcounter|addtocounter|value|arabic|stepcounter|newenvironment|renewenvironment|ref|vref|eqref|pageref|label|cite[a-zA-Z]*|tag|begin|end|bibitem)\\b"},{token:"keyword",regex:"\\\\(?:[a-zA-z0-9]+|[^a-zA-z0-9])",next:"start"},{token:"paren.keyword.operator",regex:"[[({]"},{token:"paren.keyword.operator",regex:"[\\])]"},{token:"paren.keyword.operator",regex:"}",next:"start"},{token:"nospell."+e,regex:"\\s+"},{token:"nospell."+e,regex:"\\w+"}]}};r.inherits(o,s),t.TexHighlightRules=o}),ace.define("ace/mode/r_highlight_rules",["require","exports","module","ace/lib/oop","ace/lib/lang","ace/mode/text_highlight_rules","ace/mode/tex_highlight_rules"],function(e,t,n){var r=e("../lib/oop"),i=e("../lib/lang"),s=e("./text_highlight_rules").TextHighlightRules,o=e("./tex_highlight_rules").TexHighlightRules,u=function(){var e=i.arrayToMap("function|if|in|break|next|repeat|else|for|return|switch|while|try|tryCatch|stop|warning|require|library|attach|detach|source|setMethod|setGeneric|setGroupGeneric|setClass".split("|")),t=i.arrayToMap("NULL|NA|TRUE|FALSE|T|F|Inf|NaN|NA_integer_|NA_real_|NA_character_|NA_complex_".split("|"));this.$rules={start:[{token:"comment.sectionhead",regex:"#+(?!').*(?:----|====|####)\\s*$"},{token:"comment",regex:"#+'",next:"rd-start"},{token:"comment",regex:"#.*$"},{token:"string",regex:'["]',next:"qqstring"},{token:"string",regex:"[']",next:"qstring"},{token:"constant.numeric",regex:"0[xX][0-9a-fA-F]+[Li]?\\b"},{token:"constant.numeric",regex:"\\d+L\\b"},{token:"constant.numeric",regex:"\\d+(?:\\.\\d*)?(?:[eE][+\\-]?\\d*)?i?\\b"},{token:"constant.numeric",regex:"\\.\\d+(?:[eE][+\\-]?\\d*)?i?\\b"},{token:"constant.language.boolean",regex:"(?:TRUE|FALSE|T|F)\\b"},{token:"identifier",regex:"`.*?`"},{onMatch:function(n){return e[n]?"keyword":t[n]?"constant.language":n=="..."||n.match(/^\.\.\d+$/)?"variable.language":"identifier"},regex:"[a-zA-Z.][a-zA-Z0-9._]*\\b"},{token:"keyword.operator",regex:"%%|>=|<=|==|!=|\\->|<\\-|\\|\\||&&|=|\\+|\\-|\\*|/|\\^|>|<|!|&|\\||~|\\$|:"},{token:"keyword.operator",regex:"%.*?%"},{token:"paren.keyword.operator",regex:"[[({]"},{token:"paren.keyword.operator",regex:"[\\])}]"},{token:"text",regex:"\\s+"}],qqstring:[{token:"string",regex:'(?:(?:\\\\.)|(?:[^"\\\\]))*?"',next:"start"},{token:"string",regex:".+"}],qstring:[{token:"string",regex:"(?:(?:\\\\.)|(?:[^'\\\\]))*?'",next:"start"},{token:"string",regex:".+"}]};var n=(new o("comment")).getRules();for(var r=0;r