Skip to content

Commit ca757e2

Browse files
committed
feat(markdown): extend bullets, and add links, inline code and tables. Line breaks moved to inline HTML page.
1 parent 313a064 commit ca757e2

File tree

1 file changed

+113
-9
lines changed

1 file changed

+113
-9
lines changed

pages/markdown.qmd

Lines changed: 113 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -91,14 +91,24 @@ Re-render the page to see the effect.
9191

9292
## Bullet points and numbered lists
9393

94-
To create a bullet list, use `*` followed by a space and then your text:
94+
To create a bullet list, use `*` or `-` or `+` followed by a space and then your text:
9595

9696
```markdown
9797
* Bullet point 1
9898
* Bullet point 2
9999
* Bullet point 3
100100
```
101101

102+
Can give more space by having blank lines between items
103+
104+
```markdown
105+
* Bullet point 1
106+
107+
* Bullet point 2
108+
109+
* Bullet point 3
110+
```
111+
102112
You can indent with spaces (or tab) to create sub-bullets:
103113

104114
```markdown
@@ -108,7 +118,7 @@ You can indent with spaces (or tab) to create sub-bullets:
108118
* Back to level 1
109119
```
110120

111-
A numbered list is created in a similar way using numbers (or letters):
121+
A numbered list is created in a similar way using numbers, letters or Roman numerals, or can use #, will just give deciminal numbers from 1:
112122

113123
```markdown
114124
1. Numbered point 1
@@ -134,7 +144,7 @@ To create a checklist, add `[ ]` between the bullet and text. You can then click
134144

135145
:::
136146

137-
## Indented text
147+
## Block quotes
138148

139149
To indent text as a block quote, use `>` at the start of the line:
140150

@@ -152,22 +162,116 @@ You can use this for quotes, highlights, or short notes.
152162

153163
:::
154164

155-
## Line break
165+
## Links
166+
167+
You can create a link by putting the link text in square brackets and the web address in parentheses:
168+
169+
```markdown
170+
[University of Exeter](https://www.exeter.ac.uk/)
171+
```
172+
173+
[University of Exeter](https://www.exeter.ac.uk/)
156174

157-
You can insert a line break using `<br>`.
175+
If you just paste a URL, you should wrap it in angle brackets to ensure it is clickable:
158176

159177
```markdown
160-
First part of the sentence.<br>Second part on a new line.
178+
<https://www.exeter.ac.uk/>
161179
```
162180

181+
<https://www.exeter.ac.uk/>
182+
163183
::: {.pale-blue}
164184

165185
**Task:** In `markdown.qmd`:
166186

167-
* [ ] Write a short sentence, then use `<br>` to put a second short sentence on the next line with a line break between them.
187+
* [ ] Add one link with custom link text.
188+
* [ ] Add one bare URL wrapped in `< >` so that it becomes clickable.
168189

169190
:::
170191

171-
## Hyperlinks
192+
## Inline code and code blocks
193+
194+
You can show short bits of code or filenames using single backticks.
195+
This is good for things like file names, commands, and short code fragments.
172196

173-
TODO
197+
Example:
198+
199+
:::: {.columns}
200+
::: {.column width=50%}
201+
```markdown
202+
Run `python script.py` in your terminal.
203+
204+
Open `analysis.qmd` and edit the first section.
205+
```
206+
:::
207+
::: {.column width=5%}
208+
:::
209+
::: {.column width=45%}
210+
Run `python script.py` in your terminal.
211+
212+
Open `analysis.qmd` and edit the first section.
213+
:::
214+
::::
215+
216+
For longer code, use a code block fenced with three backticks:
217+
218+
:::: {.columns}
219+
::: {.column width=50%}
220+
````markdown
221+
```bash
222+
python script.py --help
223+
echo "Hello, world"
224+
```
225+
````
226+
:::
227+
::: {.column width=5%}
228+
:::
229+
::: {.column width=45%}
230+
```bash
231+
python script.py --help
232+
echo "Hello, world"
233+
```
234+
:::
235+
::::
236+
237+
::: {.pale-blue}
238+
239+
**Task:** In `markdown.qmd`:
240+
241+
* [ ] Use inline code (single backticks) to show one filename and one command.
242+
* [ ] Add a fenced code block with 2-3 lines of example code (any language you like) - or just some text if you are unfamiliar.
243+
244+
:::
245+
246+
## Tables
247+
248+
You can create simple tables using pipes `|` and dashes `-`:
249+
250+
:::: {.columns}
251+
::: {.column width=30%}
252+
```markdown
253+
| Letter | Number |
254+
| - | - |
255+
| A | 1 |
256+
| B | 2 |
257+
| C | 3 |
258+
```
259+
:::
260+
::: {.column width=5%}
261+
:::
262+
::: {.column width=65%}
263+
| Letter | Number |
264+
| - | - |
265+
| A | 1 |
266+
| B | 2 |
267+
| C | 3 |
268+
:::
269+
::::
270+
271+
::: {.pale-blue}
272+
273+
**Task:** In `markdown.qmd`:
274+
275+
* [ ] Create a small table with two columns and at least three rows (for example, "Item" and "Quantity").
276+
277+
:::

0 commit comments

Comments
 (0)