Skip to content

Commit 241c141

Browse files
committed
CONTRIBUTING: document 'challenge' custom container (#175)
1 parent efef11c commit 241c141

1 file changed

Lines changed: 17 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,20 @@
55
- Try to split the PR in small, self-contained parts so they can be reviewed and merged faster (and independently)
66
- Make sure the code you are adding/changing follows the [GB ASM Style guide](https://gbdev.io/guides/asmstyle.html)
77
- When adding new content, give first a read to the existing chapters to get an idea of the style and teaching strategies of the document
8-
- gb-asm-tutorial is powered by the same preprocessors and renderers we developed for Pan Docs. This gives you additional features over plain Markdown, most notably the "custom containers". To see how to use them, read the ["Special markup" paragraph](https://github.com/gbdev/pandocs/blob/master/CONTRIBUTING.md#special-markup) of the Pan Docs' CONTRIBUTING.md
8+
- gb-asm-tutorial is powered by the same preprocessors and renderers we developed for Pan Docs. This gives you additional features over plain Markdown, most notably the "custom containers". To see how to use them, read the ["Special markup" paragraph](https://github.com/gbdev/pandocs/blob/master/CONTRIBUTING.md#special-markup) of the Pan Docs' CONTRIBUTING.md. One additional custom container available in gb-asm-tutorial (not in Pan Docs) is `challenge`, which can be used to add practice questions to a page:
9+
10+
````markdown
11+
:::challenge Challenge!
12+
13+
Challenge problem/questions
14+
15+
<details>
16+
<summary>Answer (Click me!)</summary>
17+
18+
This is where answers for the challenges will be placed!
19+
20+
</details>
21+
<br />
22+
23+
:::
24+
````

0 commit comments

Comments
 (0)