https://github.com/cderv/demo-rstrap

EXPERIMENTAL - R Markdown without Bootstrap dependency
https://github.com/cderv/demo-rstrap

Last synced: about 1 month ago
JSON representation

EXPERIMENTAL - R Markdown without Bootstrap dependency

• Host: GitHub
• URL: https://github.com/cderv/demo-rstrap
• Owner: cderv
• License: other
• Created: 2021-05-14T15:24:08.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-11-28T16:45:16.000Z (about 1 year ago)
• Last Synced: 2024-10-11T18:51:20.568Z (2 months ago)
• Language: R
• Homepage:
• Size: 1.03 MB
• Stars: 1
• Watchers: 2
• Forks: 2
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• jimsghstars - cderv/demo-rstrap - EXPERIMENTAL - R Markdown without Bootstrap dependency (R)

README

        

# demo-rstrap

[![Project Status: Concept – Minimal or no implementation has been done yet, or the repository is only intended to be a limited example, demo, or proof-of-concept.](https://www.repostatus.org/badges/latest/concept.svg)](https://www.repostatus.org/#concept)"

This repo contains an example site to see how rendering using `rstrap` instead of `bootstrap` looks like.

## What is rstrap ? Why woud I need this ?

`rstrap` is a forked of Bootstrap specially made to be used with rmarkdown for default feature. 

In most case this is not to be used. You would need this only 

* when you can't use Bootstrap own distribution for any reason, 

* but you would be able to use a fork maintained and provided by us.

If you wandered the web and stumble here instead of being pointed to this repo, then it means you probably don't need this.

## Example

See the demo site to see how it looks like: https://cderv.github.io/demo-rstrap/ 

## Building this website

* We use `renv` for dependency management. `renv::restore()` will install every required dependencies

* We use a `Makefile` to build the website. This allows to build the demo website using two different `html_document()` variations: 

  * default `render_site()` happens while rstrap mode has been opt-in

  * Reference page is build by opting-out rstrap mode to use the default Bootstrap 4 theming of `html_document()`. 

* This website is built automatically using those 2 tools by a Github action workflow on every push to the main branch.