Skip to content

Commit 4ef064f

Browse files
committed
update the text in section lesson formatting
1 parent 9eeac8e commit 4ef064f

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

CONTRIBUTING.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,24 @@ The following link will guide you through a list of tools for several editors:
5959

6060
### Lesson organization
6161

62-
[swc-lesson-organization]
63-
62+
Each lesson is made up of episodes, which are focused on a particular topic and include time for both teaching and exercises. If you are making a new episode, please make sure the content conforms to the [Carpentries lesson organization][swc-lesson-organization].
6463

6564
### Lesson formatting
66-
[RMarkdown](https://rmarkdown.rstudio.com/)
67-
[swc-lesson-formatting]
65+
66+
Episodes files are [Markdown](https://en.wikipedia.org/wiki/Markdown) files. If you are making a new episode or contributing to existing ones, please make sure the content conforms to the [Carpentries lesson formatting][swc-lesson-formatting].
67+
We recommend using a linter to check errors in Markdown files.
68+
For example, a [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) can be installed as an extension in ``Visual Studio Code``.
69+
Alternatively, it can installed with:
70+
71+
```bash
72+
gem install mdl
73+
```
74+
75+
and can be used as:
76+
77+
```bash
78+
mdl your_markdown_filename
79+
```
6880

6981
## Previewing your changes locally
7082

0 commit comments

Comments
 (0)