Skip to content

Commit 0fb7002

Browse files
authored
Merge pull request #102 from btel/linking-headers-ids
add a callout about header IDs
2 parents 4a744d7 + 26bc6a3 commit 0fb7002

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

_episodes/04-formatting.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,17 @@ Authors should *not* use:
9797
* sub-headings
9898
* HTML layout (e.g., `div` elements).
9999

100+
101+
> ## Linking section IDs
102+
>
103+
> In the HTML output each header of a section, code sample, exercise will be associated with an unique ID (the rules of
104+
> the ID generation are given in kramdown [documentation](https://kramdown.gettalong.org/converter/html.html#auto-ids),
105+
> but it is easier to look for them directly in the page sources).
106+
> These IDs can be used to easily link to the section by attaching the hash (`#`) followed by the ID to the page's URL
107+
> (like [this](#linking-section-ids)). For example, the instructor might copy the link to
108+
> the etherpad, so that the lesson opens in learners' web browser directly at the right spot.
109+
{: .callout}
110+
100111
## Formatting Code
101112

102113
Inline code fragments are formatted using back-quotes.

0 commit comments

Comments
 (0)