From a3d91ac3d7c76b3f0fdd4509fab7f0420e9ef62d Mon Sep 17 00:00:00 2001 From: Sally McGrath Date: Fri, 20 Sep 2024 17:37:38 +0100 Subject: [PATCH] add some headings --- readme.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/readme.md b/readme.md index 782397dd..4fc6b2a0 100644 --- a/readme.md +++ b/readme.md @@ -30,24 +30,24 @@ Pull requests against this repo will automatically generate disposable branch pr 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 This note will just be a block of text on GitHub, but a styled section on the curriculum 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.