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
+16-16Lines changed: 16 additions & 16 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ Posts within this design history website are written using [Markdown](https://en
14
14
15
15
You don’t have to do anything special for paragraphs, except for making sure that there is an empty line between each one.
16
16
17
-
```md
17
+
```md { .nhsuk-code--button }
18
18
This is a paragraph.
19
19
20
20
This is another paragraph.
@@ -31,7 +31,7 @@ Do not include a post title (h1) as this will be generated automatically from th
31
31
32
32
You do not need to create a heading before the introductory paragraph.
33
33
34
-
```md
34
+
```md { .nhsuk-code--button }
35
35
This is an introductory paragraph.
36
36
37
37
## Heading
@@ -49,7 +49,7 @@ To create links, you have to use a combination of square brackets and round brac
49
49
50
50
The square brackets come first, and contain the link text. This must be immediately followed by round brackets which contain the URL.
51
51
52
-
```md
52
+
```md { .nhsuk-code--button }
53
53
For more information, see [vaccinations on the NHS website](https://www.nhs.uk/vaccinations/).
54
54
```
55
55
@@ -59,7 +59,7 @@ If you are linking to another post on this design history site, you should not i
59
59
60
60
This should start with a forward slash (`/`) character:
61
61
62
-
```md
62
+
```md { .nhsuk-code--button }
63
63
We previously wrote about [the pilot](/screening-invite/2025/06/invite-pilot-overview/).
64
64
```
65
65
@@ -71,7 +71,7 @@ To create a footnote reference, add a caret with an identifier inside brackets `
71
71
72
72
Add the footnote using another caret and number inside brackets with a colon and the associated text `[^1]: My footnote`. You don't have to put footnotes at the end of the markdown document -- that's where they will be rendered though. This can make it easier to add a footnote reference and a footnote close to each other.
73
73
74
-
```md
74
+
```md { .nhsuk-code--button }
75
75
Here's a simple footnote,[^1] and here's a longer one.[^bignote]
76
76
77
77
[^1]: This is the first footnote.
@@ -109,7 +109,7 @@ You can add bullet lists by starting each item of the list with a dash (`-`) cha
109
109
110
110
There should be a blank line before and after each list.
111
111
112
-
```md
112
+
```md { .nhsuk-code--button }
113
113
We have 3 user types:
114
114
115
115
- administrators
@@ -123,7 +123,7 @@ If the order of items in your list is significant, use a numbered list.
123
123
124
124
Each item in the list should start with a number, a full stop and then a space.
125
125
126
-
```md
126
+
```md { .nhsuk-code--button }
127
127
This was our design process:
128
128
129
129
1. Desk research
@@ -138,7 +138,7 @@ You can add quotations by starting each line of the quote using a greater than (
138
138
139
139
If you are quoting a user taking part in research, they should not be identifiable.
140
140
141
-
```md
141
+
```md { .nhsuk-code--button }
142
142
As the NHS vaccination strategy says:
143
143
144
144
> Vaccination services and activities should be holistic.
@@ -156,7 +156,7 @@ This is shown like this:
156
156
157
157
You can attribute a quote to its author by adding two hyphens (`--`) before the attribution you want to add.
158
158
159
-
```md
159
+
```md { .nhsuk-code--button }
160
160
> No society can legitimately call itself civilised if a sick person is denied aid because of lack of means.
161
161
> -- Nye Bevan, 1952
162
162
```
@@ -176,7 +176,7 @@ The alt text should contain the key information within the image that is being d
176
176
177
177
Within the round brackets you must include the exact name of the image file, which is case sensitive.
178
178
179
-
```md
179
+
```md { .nhsuk-code--button }
180
180
We redesigned the homepage to clearly list the different services within our portfolio:
181
181
182
182

@@ -190,7 +190,7 @@ The caption is in addition to alt text. Unlike the alt text, the caption cab be
190
190
191
191
The caption is added inside the round brackets, after the file name, within double quotes (`"`).
192
192
193
-
```md
193
+
```md { .nhsuk-code--button }
194
194
This is our brand:
195
195
196
196

@@ -208,7 +208,7 @@ To add tables, use the pipe (`|`) character to separate the columns and at the s
208
208
209
209
The table should start with a row that contains headings for each column. After this heading row, add a row using dash (`-`) characters in each column to separate the column headings from the table data.
210
210
211
-
```md
211
+
```md { .nhsuk-code--button }
212
212
These are the questions we included in the survey:
213
213
214
214
| Field | Format | Type |
@@ -225,7 +225,7 @@ Notes can be used emphasise important information or to highlight content that h
225
225
226
226
To add a note, start each line with a `>` character, and add `> [!NOTE]` on the line immediately above:
227
227
228
-
```markdown
228
+
```markdown { .nhsuk-code--button }
229
229
> [!NOTE]
230
230
> In the UK, 1 in 5 people is disabled.
231
231
>
@@ -241,7 +241,7 @@ This will display as:
241
241
242
242
You can also include a title:
243
243
244
-
```markdown
244
+
```markdown { .nhsuk-code--button }
245
245
> [!NOTE] Help take part in research
246
246
> We’d like to spend 20 minutes talking to you about your experiences.
247
247
```
@@ -255,7 +255,7 @@ The rendered output looks like this:
255
255
256
256
Alerts are rendered as [warning callouts](https://service-manual.nhs.uk/design-system/components/warning-callout):
257
257
258
-
```markdown
258
+
```markdown { .nhsuk-code--button }
259
259
> [!IMPORTANT]
260
260
> This assumption has not yet been validated.
261
261
```
@@ -267,7 +267,7 @@ This displays as:
267
267
268
268
If you include a title, this will be shown in the heading instead:
269
269
270
-
```markdown
270
+
```markdown { .nhsuk-code--button }
271
271
> [!IMPORTANT] Clinical note
272
272
> This guidance was based on information in the Patient Group Direction (PGD).
0 commit comments