Skip to content

Commit

Permalink
markdown source builds
Browse files Browse the repository at this point in the history
Auto-generated via {sandpaper}
Source  : 9271ca1
Branch  : main
Author  : Zhian N. Kamvar <[email protected]>
Time    : 2023-06-29 16:53:33 +0000
Message : Merge pull request #147 from carpentries/zkamvar-patch-2

update style guide to use "characters" not "colons"
  • Loading branch information
actions-user committed Jun 29, 2023
1 parent bacf884 commit a1f6a03
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 19 deletions.
2 changes: 1 addition & 1 deletion md5sum.txt
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"learners/setup.md" "04be5f060e281fdd218dcaa3407e1b48" "site/built/setup.md" "2023-06-15"
"learners/github-pat.md" "65a2c6f46233a1335a6fc0392cb8a405" "site/built/github-pat.md" "2023-06-15"
"learners/component-guide.md" "a9e1ecc182d805213688090b6aa38cfa" "site/built/component-guide.md" "2023-06-15"
"learners/style.md" "26654aa1bbd06e09fe3f11c57c2acaf1" "site/built/style.md" "2023-06-16"
"learners/style.md" "59a4d847201ced45d9b78b8ec9b05993" "site/built/style.md" "2023-06-29"
"profiles/maintainer.md" "2a2b790c0aa8da5fb72e323e4fafabd9" "site/built/maintainer.md" "2023-06-15"
"profiles/instructor.md" "ff8c586028a5e1c7ef0be4178b40417c" "site/built/instructor.md" "2023-06-15"
"renv/profiles/lesson-requirements/renv.lock" "dff30c3bcf48b0b7a17270b81595a680" "site/built/renv.lock" "2023-06-15"
36 changes: 18 additions & 18 deletions style.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,64 +23,64 @@ in source files.

#### First-level fenced divs

For increased legibility, we recommend an opening fence length of at least 50 colons
For increased legibility, we recommend an opening fence length of around 50 characters
(half to two-thirds of the screen),
with a single space between the last colon and the class keyword.
The length of closing fences should match the length of the opening fence plus keyword,
for example:

```markdown
:::::::::::::::::::::::::::::::::::::::::::::::::: callout
:::::::::::::::::::::::::::::::::::::::::: callout

### An example callout

This callout was opened with a fence of 50 colons.
This callout was opened with a fence of 50 characters.
The end of the closing fence aligns with
the last character in the 'callout' keyword.

::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
::::::::::::::::::::::::::::::::::::::::::::::::::
```

#### Nested fenced divs (e.g. challenge solutions)

Where fenced divs are nested,
e.g. attaching a solution block to a challenge,
we recommend making the inner fences noticably shorter
than the outer fences, e.g. 25 colons (one quarter to one third of the screen).
than the outer fences, e.g. 25 characters (one quarter to one third of the screen).
E.g.

```markdown
:::::::::::::::::::::::::::::::::::::::::::::::::: challenge
:::::::::::::::::::::::::::::::::::::::: challenge

### An example challenge

This challenge was opened with a fence of 50 colons.
This challenge was opened with a fence of 50 characters.

::::::::::::::::::::::::: solution
:::::::::::::::: solution

The nested solution block was opened with 25 colons,
The nested solution block was opened with 25 characters,
to make it stand out from the challenge.

::::::::::::::::::::::::::::::::::
:::::::::::::::::::::::::

::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
::::::::::::::::::::::::::::::::::::::::::::::::::
```

#### Instructor Notes

Content written into divs with the 'instructor' class will only appear
in the Instructor View of the lesson website.
To help distinguish these blocks from the rest of the page content,
we recommend a longer fence length (80 colons) for 'instructor' blocks:
we recommend a longer fence length (80 characters) for 'instructor' blocks:

```markdown
:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: instructor
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::: instructor

## Stay hydrated

Rememeber to pause and drink some water.

:::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
```

### Whitespace
Expand All @@ -90,20 +90,20 @@ For legibility and to avoid
empty lines should flank the fences of a fenced div, e.g.

```markdown
:::::::::::::::::::::::::::::::::::::::::::::::::: callout
:::::::::::::::::::::::::::::::::::::::::: callout

### Good: whitespace either side of the fences

This will ensure Markdown content renders as intended.

::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
::::::::::::::::::::::::::::::::::::::::::::::::::

:::::::::::::::::::::::::::::::::::::::::::::::::: callout
:::::::::::::::::::::::::::::::::::::::::: callout
### Not recommended
Without empty lines flanking the opening and closing fences,
this callout is more difficult to read
and some Markdown content such as lists may not render as intended.
::::::::::::::::::::::::::::::::::::::::::::::::::::::::::
::::::::::::::::::::::::::::::::::::::::::::::::::
```

## Figures
Expand Down

0 comments on commit a1f6a03

Please sign in to comment.