https://github.com/liangyy/template_r_documentation
This is a light template for documentation based on rmarkdown
https://github.com/liangyy/template_r_documentation
Last synced: 5 months ago
JSON representation
This is a light template for documentation based on rmarkdown
- Host: GitHub
- URL: https://github.com/liangyy/template_r_documentation
- Owner: liangyy
- License: gpl-3.0
- Created: 2017-04-08T20:18:44.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2023-04-16T23:46:40.000Z (about 2 years ago)
- Last Synced: 2024-08-09T02:19:58.653Z (8 months ago)
- Homepage: http://liangyy.github.io/template_r_documentation
- Size: 1.19 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - liangyy/template_r_documentation - This is a light template for documentation based on rmarkdown (Others)
README
# template_r_documentation
This is a light template for documentation based on rmarkdown.
## Overview
This is based on rmarkdown. As a quick look at how things work, the way the documentations glued together is:
1. `_site.yml` tells what should be at navigation bar and it also determines the overall style.
2. `index.html` and other files that are linked by `_site.yml` can further link to other files (namely sub contents).
3. run `render_site([file-name])` to generate `html` file from `Rmd` file.
4. add, commit, and push everything at the end of the day.
## Notes
1. `docs/` contains all `html` files and be sure to enable Github Pages (`docs/` mode).
2. put all `Rmd` files at `rmd/` and in R terminal, run `render_site('rmd/filename.Rmd')` and it will generate the corresponding `html` at `docs/`
## Build yourself
All you need to get started is the files in `rmd/`. Once you get them, do the following in R terminal:
```
setwd('some_path/template_r_documentation')
library(rmarkdown)
render_site(input = 'rmd/')
```
To render a new file, say `new.Rmd`, do:
```
render_site(input = 'rmd/new.Rmd`)
```
## See also
This is a super light and lazy (quick) solution. It is inspired by [this post](http://nickstrayer.me/RMarkdown_Sites_tutorial/) and [workflowr](https://github.com/jdblischak/workflowr). To get a more advanced and prettier solution, please check out [workflowr](https://github.com/jdblischak/workflowr).