forked from r-lib/pkgdown
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathREADME.Rmd
44 lines (30 loc) · 2.07 KB
/
README.Rmd
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
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, echo = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "README-"
)
```
# pkgdown
[](https://travis-ci.org/r-lib/pkgdown)
[](https://cran.r-project.org/package=pkgdown)
[](https://codecov.io/github/r-lib/pkgdown?branch=master)
pkgdown is designed to make it quick and easy to build a website for your package. You can see pkgdown in action at <http://pkgdown.r-lib.org/>: this is the output of pkgdown applied to the latest version of pkgdown. Learn more in `vignette("pkgdown")` or `?build_site`.
## Installation
pkgdown is not currently available from CRAN, but you can install the development version from github with:
```{r, eval = FALSE}
# install.packages("devtools")
devtools::install_github("r-lib/pkgdown")
```
## Usage
Run pkgdown from the package directory each time you release your package:
```{r, eval = FALSE}
pkgdown::build_site()
```
This will generate a `docs/` directory. The home page will be generated from your package's `README.md`, and a function reference will be generated from the documentation in the `man/` directory. If you are using GitHub, the easiest way to make this your package website is to check into git, then go settings for your repo and make sure that the __GitHub pages__ source is set to "master branch /docs folder".
The package also includes an RStudio add-in which you can bind to a keyboard shortcut. I recommend `Cmd + Shift + W`: it uses Cmd + Shift, like all other package development worksheets, it replaces a rarely used command (close all tabs), and the W is mnemonic for website.
To customise your site, create `_pkgdown.yml` and modify it as described in the documentation. Alternatively, you can also use `pkgdown/_pkgdown.yml` if you need other files to customise your site.