You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
[](https://app.codecov.io/gh/rstudio/bookdown?branch=main)
7
-
<!-- badges: end -->
8
4
5
+
[](https://github.com/rstudio/bookdown/actions/workflows/R-CMD-check.yaml)[](https://CRAN.R-project.org/package=bookdown)[](https://app.codecov.io/gh/rstudio/bookdown?branch=main)
6
+
7
+
<!-- badges: end -->
9
8
10
9
A open-source (GPL-3) R package to facilitate writing books and long-form articles/reports with R Markdown. Features include:
11
10
12
-
- Generate printer-ready books and ebooks from R Markdown documents
13
-
- A markup language easier to learn than LaTeX, and to write elements such as section headers, lists, quotes, figures, tables, and citations
14
-
- Multiple choices of output formats: PDF, LaTeX, HTML, EPUB, and Word.
15
-
- Possibility of including dynamic graphics and interactive applications (HTML widgets and Shiny apps)
16
-
- Support for languages other than R, including C/C++, Python, and SQL, etc.
17
-
- LaTeX equations, theorems, and proofs work for all output formats
18
-
- Can be published to GitHub, bookdown.org, and any web servers
19
-
- Integrated with the RStudio IDE
20
-
- One-click publishing to <https://bookdown.org>
11
+
-Generate printer-ready books and ebooks from R Markdown documents
12
+
-A markup language easier to learn than LaTeX, and to write elements such as section headers, lists, quotes, figures, tables, and citations
13
+
-Multiple choices of output formats: PDF, LaTeX, HTML, EPUB, and Word.
14
+
-Possibility of including dynamic graphics and interactive applications (HTML widgets and Shiny apps)
15
+
-Support for languages other than R, including C/C++, Python, and SQL, etc.
16
+
-LaTeX equations, theorems, and proofs work for all output formats
17
+
-Can be published to GitHub, bookdown.org, and any web servers
18
+
-Integrated with the RStudio IDE
19
+
-One-click publishing to <https://bookdown.org>
21
20
22
21
## Book
23
22
24
-
<ahref="https://bookdown.org/yihui/bookdown/"><imgclass="book"src="https://bookdown.org/yihui/bookdown/images/cover.jpg"alt = "bookdown: Authoring Books and Technical Documents with R Markdown"height="400"></a>
23
+
<ahref="https://bookdown.org/yihui/bookdown/"><imgsrc="https://bookdown.org/yihui/bookdown/images/cover.jpg"alt="bookdown: Authoring Books and Technical Documents with R Markdown"class="book"height="400"/></a>
25
24
26
25
## Installation
27
26
28
27
You can install the package from CRAN as follows:
29
28
30
-
```r
29
+
```r
31
30
install.packages("bookdown")
32
31
```
33
32
34
33
If you want to use the development version of the **bookdown** package, you can install the package from GitHub via the [**remotes** package](https://remotes.r-lib.org):
35
34
36
-
```r
37
-
remotes::install_github('rstudio/bookdown')
35
+
```r
36
+
# install.packages("pak")
37
+
pak::pak('rstudio/bookdown')
38
38
```
39
39
40
40
## Usage
41
41
42
-
The easiest way to start a new Bookdown project is from within RStudio IDE. Go to _File > New Project > New Directory > Book project using bookdown_.
42
+
The easiest way to start a new Bookdown project is from within RStudio IDE. Go to *File \> New Project \> New Directory \> Book project using bookdown*.
43
43
44
-
This will create a new directory with an example book as template. You can build the HTML version of this example book without doing any modification:
44
+
This will create a new directory with an example book as template. You can build the HTML version of this example book without doing any modification:
45
45
46
-
* Go into the Build Pane in the RStudio IDE
47
-
*Click on _Build Book > bookdown::gitbook_
46
+
- Go into the Build Pane in the RStudio IDE
47
+
-Click on *Build Book \> bookdown::gitbook*
48
48
49
49
You can also run `bookdown::render_book()` in the R console.
50
50
@@ -54,9 +54,9 @@ Learn more about using bookdown in the [Getting started section](https://pkgs.rs
54
54
55
55
There are two main places to get help:
56
56
57
-
1. The [RStudio community](https://community.rstudio.com/tags/c/R-Markdown/10/bookdown) is a friendly place to ask any questions about **bookdown**. Be sure to use the `bookdown` tag.
57
+
1.The [RStudio community](https://community.rstudio.com/tags/c/R-Markdown/10/bookdown) is a friendly place to ask any questions about **bookdown**. Be sure to use the `bookdown` tag.
58
58
59
-
1.[Stack Overflow](https://stackoverflow.com/questions/tagged/bookdown) is a great source of answers to common **bookdown** questions. Use the tags [`[r][bookdown]`](https://stackoverflow.com/questions/tagged/bookdown+r) if you ask a question.
59
+
2.[Stack Overflow](https://stackoverflow.com/questions/tagged/bookdown) is a great source of answers to common **bookdown** questions. Use the tags [`[r][bookdown]`](https://stackoverflow.com/questions/tagged/bookdown+r) if you ask a question.
0 commit comments