You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: app/guide/using-markdown.md
+60Lines changed: 60 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,8 @@ eleventyNavigation:
8
8
9
9
Posts within this design history website are written using [Markdown](https://en.wikipedia.org/wiki/Markdown), a simple markup language which saves you from having to use HTML.
10
10
11
+
[[toc]]
12
+
11
13
## Paragraphs
12
14
13
15
You don’t have to do anything special for paragraphs, except for making sure that there is an empty line between each one.
@@ -177,6 +179,64 @@ These are the questions we included in the survey:
177
179
| Consent for future contact | Boolean | Required |
178
180
```
179
181
182
+
## Notes
183
+
184
+
Notes can be used emphasise important information or to highlight content that has a different context from the rest of your post.
185
+
186
+
To add a note, start each line with a `>` character, and add `> [!NOTE]` on the line immediately above:
187
+
188
+
```markdown
189
+
> [!NOTE]
190
+
> In the UK, 1 in 5 people is disabled.
191
+
>
192
+
> This can equate to more than [16 million](https://commonslibrary.parliament.uk/research-briefings/cbp-9602/) people with disabilities
193
+
```
194
+
195
+
This will display as:
196
+
197
+
> [!NOTE]
198
+
> In the UK, 1 in 5 people is disabled.
199
+
>
200
+
> This can equate to more than [16 million](https://commonslibrary.parliament.uk/research-briefings/cbp-9602/) people with disabilities
201
+
202
+
You can also include a title:
203
+
204
+
```markdown
205
+
> [!NOTE] Help take part in research
206
+
> We’d like to spend 20 minutes talking to you about your experiences.
207
+
```
208
+
209
+
The rendered output looks like this:
210
+
211
+
> [!NOTE] Help take part in research
212
+
> We’d like to spend 20 minutes talking to you about your experiences.
213
+
214
+
## Alerts
215
+
216
+
Alerts are rendered as [warning callouts](https://service-manual.nhs.uk/design-system/components/warning-callout):
217
+
218
+
```markdown
219
+
> [!IMPORTANT]
220
+
> This assumption has not yet been validated.
221
+
```
222
+
223
+
This displays as:
224
+
225
+
> [!IMPORTANT]
226
+
> This assumption has not yet been validated.
227
+
228
+
If you include a title, this will be shown in the heading instead:
229
+
230
+
```markdown
231
+
> [!IMPORTANT] Clinical note
232
+
> This guidance was based on information in the Patient Group Direction (PGD).
233
+
```
234
+
235
+
This displays as:
236
+
237
+
> [!IMPORTANT] Clinical note
238
+
> This guidance was based on information in the Patient Group Direction (PGD).
239
+
180
240
---
181
241
182
242
See [NHS.UK Eleventy markdown guide](https://x-govuk.github.io/nhsuk-eleventy-plugin/example/markdown/) for the full list of options.
0 commit comments