Skip to content

Commit

Permalink
add some headings
Browse files Browse the repository at this point in the history
  • Loading branch information
SallyMcGrath authored Sep 20, 2024
1 parent 9d15c8c commit a3d91ac
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,24 +30,24 @@ Pull requests against this repo will automatically generate disposable branch pr
</summary>

These workshops are pulled through to various front ends and displayed using the [CYF Common Theme](https://common.codeyourfuture.io/). Write for GitHub first, but you can secretly jazz up your layouts for those contexts by using [Hugo shortcodes](https://common.codeyourfuture.io/common-theme/shortcodes/) wrapped in HTML comments. You can add any shortcode in comments and it will be parsed and rendered on our curriculum sites, but not here.

#### Look in the source code
<!--{{<note>}}-->
This note will just be a block of text on GitHub, but a styled section on the curriculum
<!--{{</note>}}-->

We are working on uniting the views as much as we can. These features can be rendered in both places:

#### Notes
>[!TIP]
>GitHub style notes will be rendered as notes on Common
#### Objectives
```objectives
- Start with the active verb
- Make your objectives testable
```
Objectives wrapped in a [codeblock with the string objectives](https://common.codeyourfuture.io/common-theme/render-hooks/objectives/) will be piped into the [curriculum success pages](https://common.codeyourfuture.io/common-theme/pages/success/)

#### Diagrams
```mermaid
LR
flowchart LR
A-->B
```
[Mermaid](https://mermaid.live/edit) works on [Common, exactly the same,](https://common.codeyourfuture.io/common-theme/render-hooks/mermaid/) and any diagrams you write in a readme or issue will render there too. There’re flowcharts, sequence diagrams, gantt charts, mindmaps, and more.
Expand Down

0 comments on commit a3d91ac

Please sign in to comment.