Skip to content

Commit c32a1cf

Browse files
committed
appease markdownlint-cli2
1 parent 4052af7 commit c32a1cf

File tree

2 files changed

+12
-17
lines changed

2 files changed

+12
-17
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
A short course on the basics of software testing in Python using the `pytest` library.
44

5-
This lesson uses [The Carpentries Workbench][workbench] template.
5+
This lesson uses [The Carpentries Workbench](https://carpentries.github.io/workbench/) template.
66

77
## Course Description
88

@@ -33,27 +33,27 @@ Contributions are welcome, please refer to the [contribution guidelines](CONTRIB
3333
that you adhere to the [Code of Conduct](CODE_OF_CONDUCT.md).
3434

3535
### Build the lesson locally
36-
37-
To render the lesson locally, you will need to have [R][rlang] installed. Instructions for using R with the Carpentries
38-
template is [available](https://carpentries.github.io/workbench/#installation) but some additional setps have been
39-
taken to make sure the environment is reproducible using the
36+
<!-- markdownlint-disable MD053 -->
37+
To render the lesson locally, you will need to have [R](https://www.r-project.org/) installed. Instructions for using
38+
R with the Carpentries template is [available](https://carpentries.github.io/workbench/#installation) but some
39+
additional setps have been taken to make sure the environment is reproducible using the
4040
[`{renv}`](https://rstudio.github.io/renv/articles/renv.html) package and an `renv.lockfile` is included which allows
4141
the environment to be re-created along with dependencies.
4242

4343
After cloning the repository, you can set up the `renv` and install all packages with:
4444

45+
```r
4546
renv::restore()
4647

4748
renv::update()
48-
4949
```
5050

5151
Once you have installed the dependencies, you can render the pages locally by starting R in the project root and
5252
running:
53-
``` r
53+
54+
```r
5455
sandpaper::serve()
56+
```
57+
5558
This will build the pages and start a local web-server in R and open it in your browser. These pages are "live" and
5659
will respond to local file changes if you save them.
57-
58-
[rlang]: https://www.r-project.org/
59-
[workbench]: https://carpentries.github.io/workbench/

index.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,5 @@
1-
<!-- markdownlint-disable MD041 -->
21
---
2+
33
site: sandpaper::sandpaper_site
44
---
5-
6-
This is a new lesson built with [The Carpentries Workbench][workbench].
7-
8-
9-
[workbench]: https://carpentries.github.io/sandpaper-docs
10-
5+
# This is a new lesson built with [The Carpentries Workbench](https://carpentries.github.io/sandpaper-docs)

0 commit comments

Comments
 (0)