Commit 0fb70020 authored by Raniere Silva's avatar Raniere Silva Committed by GitHub
Browse files

Merge pull request #102 from btel/linking-headers-ids

add a callout about header IDs
parents 4a744d73 26bc6a3f
Loading
Loading
Loading
Loading
+11 −0
Original line number Diff line number Diff line
@@ -97,6 +97,17 @@ Authors should *not* use:
*   sub-headings
*   HTML layout (e.g., `div` elements).


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

## Formatting Code

Inline code fragments are formatted using back-quotes.