1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
|
# bookdown <img src='man/figures/logo.png' align="right" height="139" />
<!-- badges: start -->
[](https://github.com/rstudio/bookdown/actions)
[](https://CRAN.R-project.org/package=bookdown)
[](https://app.codecov.io/gh/rstudio/bookdown?branch=main)
<!-- badges: end -->
A open-source (GPL-3) R package to facilitate writing books and long-form articles/reports with R Markdown. Features include:
- Generate printer-ready books and ebooks from R Markdown documents
- A markup language easier to learn than LaTeX, and to write elements such as section headers, lists, quotes, figures, tables, and citations
- Multiple choices of output formats: PDF, LaTeX, HTML, EPUB, and Word.
- Possibility of including dynamic graphics and interactive applications (HTML widgets and Shiny apps)
- Support for languages other than R, including C/C++, Python, and SQL, etc.
- LaTeX equations, theorems, and proofs work for all output formats
- Can be published to GitHub, bookdown.org, and any web servers
- Integrated with the RStudio IDE
- One-click publishing to <https://bookdown.org>
## Book
<a href="https://bookdown.org/yihui/bookdown/"><img class="book" src="https://bookdown.org/yihui/bookdown/images/cover.jpg" alt = "bookdown: Authoring Books and Technical Documents with R Markdown" height="400"></a>
## Installation
You can install the package from CRAN as follows:
```r
install.packages("bookdown")
```
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):
```r
remotes::install_github('rstudio/bookdown')
```
## Usage
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_.
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:
* Go into the Build Pane in the RStudio IDE
* Click on _Build Book > bookdown::gitbook_
You can also run `bookdown::render_book()` in the R console.
Learn more about using bookdown in the [Getting started section](https://pkgs.rstudio.com/bookdown/articles/bookdown.html).
## Getting help
There are two main places to get help:
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.
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.
## Code of Conduct
Please note that the bookdown project is released with a [Contributor Code of Conduct](https://pkgs.rstudio.com/bookdown/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.
|
