https://github.com/carpentries/sandpaper-docs

Documentation for The Carpentries Workbench
https://github.com/carpentries/sandpaper-docs

Last synced: 3 months ago
JSON representation

Documentation for The Carpentries Workbench

• Host: GitHub
• URL: https://github.com/carpentries/sandpaper-docs
• Owner: carpentries
• License: other
• Created: 2021-02-09T19:59:02.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-08-13T00:23:17.000Z (3 months ago)
• Last Synced: 2024-08-13T02:28:12.410Z (3 months ago)
• Language: R
• Homepage: https://carpentries.github.io/sandpaper-docs/
• Size: 9.97 MB
• Stars: 4
• Watchers: 6
• Forks: 41
• Open Issues: 22
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md
  • Citation: CITATION.cff

Awesome Lists containing this project

• jimsghstars - carpentries/sandpaper-docs - Documentation for The Carpentries Workbench (R)

README

        
# The Carpentries Workbench Documentation

This lesson gives a high-level overview of how you can use The Carpentries

Workbench (our new and improved lesson infrastructure) to build beautiful and

accessible lessons from markdown or RMarkdown sources.

If you want to try out this lesson, you can create a copy of it on the RStudio

Cloud: https://rstudio.cloud/project/3507333

## Setup the Workbench

To build this lesson locally, you should follow the [setup instructions for the

workbench](https://carpentries.github.io/sandpaper-docs/#overview). In short,

make sure you have R, Git, and Pandoc installed, open R and use the following

commands to install/update the packages needed for the infrastructure:

```r

# register the repositories for The Carpentries and CRAN

options(repos = c(

  carpentries = "https://carpentries.r-universe.dev/",

  CRAN = "https://cran.rstudio.com/"

))

# Install the template packages to your R library

install.packages(c("sandpaper", "varnish", "pegboard", "tinkr"))

```

## Download this lesson from GitHub

There are two ways to download the lesson from github:

 - via the command line: 

   ```

   git clone https://github.com/carpentries/sandpaper-docs && cd sandpaper-docs

   ```

 - via R: 

   ```r

   usethis::create_from_github("https://github.com/carpentries/sandpaper-docs/")

   ```

## Build and Preview

Launch R in this folder and use this command to build and preview the lesson

```r

sandpaper::serve()

```

[{sandpaper}]: https://carpentries.github.io/sandpaper/