README.Rmd

---
output: github_document
always_allow_html: true
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, include = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "man/figures/README-",
  out.width = "100%"
)
```

# booktem <a href="https://debruine.github.io/booktem/"><img src="man/figures/logo.png" align="right" height="120" /></a>

<!-- badges: start -->
[![Codecov test coverage](https://codecov.io/gh/debruine/booktem/branch/master/graph/badge.svg)](https://app.codecov.io/gh/debruine/booktem?branch=master)
<!-- badges: end -->

The goal of booktem is to make the creation of methods books quick and easy. It integrates with  [webexercises](https://psyteachr.github.io/webexercises/) for short self-checking quizzes and [glossary](https://debruine.github.io/glossary/) for defining terms in text and creating glossary tables.

## Installation

You can install the development version of booktem like so:

``` r
devtools::install_github("debruine/booktem")
```

## Example

Set up a book; this function creates a project at the specified path, renders the demo book in Quarto, opens the book in a web browser, and opens the project in a new RStudio window. The demo book gives examples of the features included in the book.

```{r eval = FALSE}
library(booktem)

create_book(path = "demobook", 
            title = "My Demo Book",
            authors = "My Name")
```

Set up a custom red, white and blue stripe on the top of the book (instead of the psyTeachR rainbow stripe).

```{r, eval = FALSE}
stripe_colors <- c(red = "red",
                   white = "white",
                   blue = "blue")
stripe_css <- stripes(stripe_colors, height = 10)

create_book(path = "demobook", 
            title = "My Demo Book",
            authors = "My Name",
            css = stripe_css)
```