https://github.com/grimbough/msmbstyle
Tufte inspired bookdown template
https://github.com/grimbough/msmbstyle
bookdown r rmarkdown-template
Last synced: 11 months ago
JSON representation
Tufte inspired bookdown template
- Host: GitHub
- URL: https://github.com/grimbough/msmbstyle
- Owner: grimbough
- Created: 2018-07-31T12:07:24.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2022-03-28T18:35:34.000Z (about 4 years ago)
- Last Synced: 2025-04-23T20:15:51.572Z (about 1 year ago)
- Topics: bookdown, r, rmarkdown-template
- Language: R
- Homepage: https://www-huber.embl.de/users/msmith/msmbstyle/
- Size: 552 KB
- Stars: 59
- Watchers: 4
- Forks: 18
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# **msmbstyle**
The **msmbstyle** package provides an alternative design for HTML books produced using the R package [bookdown](http://www.bookdown.org). The layout was developed to closely match an existing publication produced using Sweave and LaTeX. The general structure is heavily influenced by the handout design of Edward Tufte, with figures and annotations appearing in the margin alongside the main text, and much of the document conversion/creation is actually carried out by the [**tufte** package](https://github.com/rstudio/tufte). **msmbstyle** provides some additional modifications to the overall layout of the book.
You can view a simple example of the HTML produced by **msmbstyle** at https://www-huber.embl.de/users/msmith/msmbstyle/, and the R Markdown documents used to generate this are present in the `/inst/extdata/` folder of this package
A example of a complete book generated using **msmbstyle** can be found at [Modern Statistics for Modern Biology](https://www-huber.embl.de/msmb/) by S. Holmes & W. Huber.
## **msmbstyle** vs **tufte** styling
A (probably incomplete) list of the layout differences between an HTML book produced by **msmbstyle** and the default options in **tufte**:
- Book title and author names listed in a header bar at the top of each page.
- Document navigation provided by drop-down menu in the top right of each page.
- One entry per chapter.
- The current chapter has sections listed too.
- Sans serif font for the main text (currently using [Source Sans Pro](https://fonts.google.com/specimen/Source+Sans+Pro))
- Defines additional document sections (currently Questions & Solutions) that can be referenced in text, and have their visibility toggled within the final document
- Keeps default width of code blocks when vertically aligned with margin figures.
- Provides CSS support to place tables in the margin along with figures and notes.
### Alternate branches
The grid-layout branch uses Bootstrap to provide an alternative approach to arranging the content into columns. An example can be seen at https://www.huber.embl.de/users/msmith/msmbstyle/bootstrap/
# Acknowledgments
## Funding
Funding for development of this package and the surrounding efforts directed towards the creation of the online version of Modern Statistics for Modern Biology is provided by the German Network for Bioinformatics Infrastructure
