https://github.com/Appsilon/readmebuilder
https://github.com/Appsilon/readmebuilder
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/Appsilon/readmebuilder
- Owner: Appsilon
- Created: 2019-03-22T16:02:03.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-02-02T20:51:07.000Z (about 1 year ago)
- Last Synced: 2024-08-13T07:15:40.739Z (6 months ago)
- Language: R
- Size: 7.81 KB
- Stars: 2
- Watchers: 4
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- jimsghstars - Appsilon/readmebuilder - (R)
README
ReadmebuildeR
=============
A simple R package to automatically build consistently formated and nicely looking READMEs and simple package websites.
## Installation
```
devtools::install_github("Appsilon/readmebuilder")
```
## How to use it?
Run:
```r
build_readme("examples/README.Rmd", output_md = 'README2.md')
```
and check `examples/README.Rmd` for formatting of Rmd file.
Note **two** things here:
1. This is responsible for selecting folder which will contain all your static images generated by Rmd active R cells.
```r
knitr::opts_chunk$set(
...
fig.path = "examples/README_files/"
)
```
To access screenshots of generated active cells include `screenshot.force = TRUE` parameter in cell definition:
```
{r, screenshot.force = TRUE}
```
2. You can manipulate the style of generated `html` file just by adding this line to Rmd file:
```
```
and including `style.css` file in the folder containing your html output.
For more details check the documentation of the `build_readme` function.
## Credits
[Appsilon Data Science Team](http://appsilon.com).
Get in touch [[email protected]]([email protected])