Skip to content

Commit f6e56f0

Browse files
committed
Heading update
1 parent fb23f18 commit f6e56f0

File tree

4 files changed

+31
-27
lines changed

4 files changed

+31
-27
lines changed

individual_modules/markdown_with_python/3-Markdown-Fundamentals.md

Lines changed: 24 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -93,7 +93,7 @@ A line break within a paragraph is created by adding two spaces at the end of a
9393

9494
To create a full paragraph break (a blank line between paragraphs), you simply press Enter twice.
9595

96-
Here is an example:
96+
Here is **an example:**
9797

9898
```
9999
This is the first paragraph.
@@ -102,7 +102,7 @@ This is the second paragraph with a
102102
line break inside.
103103
```
104104

105-
### Output:
105+
**Output:**
106106
This is the first paragraph.
107107

108108
This is the second paragraph with a
@@ -133,7 +133,7 @@ Lists are a great way to make your documents easier to scan and helps readers fi
133133
### Unordered Lists (Bullets)
134134
To make a bullet point, start a line with `-`, `+`, or `*`. It is of note that the different symbols you can use to create a bulleted list are all treated the same by the Markdown processor and will therefore render identically as a disc bullet. Whilst they render the same, for consistency we recommend you use the same symbol within a list and not mix between them, because some Markdown parsers or linters may warn about inconsistent style. You can also create sublists by indenting with at least two spaces.
135135

136-
Example:
136+
**Example:**
137137
```
138138
- Item 1
139139
- Item 2
@@ -142,7 +142,7 @@ Example:
142142
143143
```
144144

145-
### Output:
145+
**Output:**
146146
- Item 1
147147
- Item 2
148148
- Subitem 2.1
@@ -159,7 +159,7 @@ To make a numbered list, just start each line with a number followed by a full s
159159
2. Subitem 2.2
160160
```
161161

162-
### Output:
162+
**Output:**
163163
1. First item
164164
2. Second item
165165
1. Subitem 2.1
@@ -172,14 +172,14 @@ Task lists are useful when you want to show items that need to be completed —
172172
- to make an unchecked box, use `- []`.
173173
- to make a checked box, use `- [x]`.
174174

175-
Example:
175+
**Example:**
176176
```
177177
- [ ] Task 1
178178
- [x] Task 2
179179
180180
```
181181

182-
### Output:
182+
**Output:**
183183

184184
- [ ] Task 1
185185
- [x] Task 2
@@ -192,13 +192,13 @@ Blockquotes are used to highlight quotes, important information, or notes in you
192192

193193
To create a blockquote, start a line with a `>` symbol. If you want to create a nested blockquote (a quote inside a quote), use `>>`.
194194

195-
Example:
195+
**Example:**
196196
```
197197
> This is a blockquote.
198198
>> This is a nested blockquote.
199199
```
200200

201-
### Output:
201+
**Output:**
202202
> This is a blockquote.
203203
>> This is a nested blockquote.
204204
@@ -211,27 +211,27 @@ Markdown makes it easy to format code, whether it's a single line or multiple li
211211

212212
To format a short piece of code inline, wrap it in single backticks (`).
213213

214-
Example:
214+
**Example**:
215215
```
216216
Use the `print()` function in Python.
217217
```
218218

219-
### Output:
219+
**Output:**
220220
Use the `print()` function in Python.
221221

222222

223223
### Code Blocks
224224

225225
For longer code or multi-line code blocks, use triple backticks (```) to create a block. You can also specify the programming language after the first set of backticks to enable syntax highlighting.
226226

227-
Example:
227+
**Example**:
228228
```
229229
```python
230230
def greet():
231231
print("Hello, World!")
232232
```
233233

234-
### Output:
234+
**Output:**
235235

236236
```python
237237
def greet():
@@ -252,7 +252,7 @@ Tables help make data clearer and more structured, especially when you need to p
252252
253253
```
254254

255-
### Output
255+
**Output:**
256256

257257
| Name | Age | Job |
258258
|-------|-----|----------|
@@ -268,7 +268,7 @@ Horizontal lines are used to separate sections of your document, providing a cle
268268
---
269269
```
270270

271-
### Output
271+
**Output:**
272272
---
273273

274274

@@ -280,12 +280,12 @@ Adding links and images is a great way to enrich your documents. In Markdown, ad
280280

281281
To create a link, use the format `[text](URL)`. This will display the text as a clickable link that directs to the specified URL.
282282

283-
Example:
283+
**Example:**
284284
```
285285
[Link text](https://www.exeter.ac.uk/)
286286
```
287287

288-
### Output
288+
**Output:**
289289
[Link text](https://www.exeter.ac.uk/)
290290

291291
**Images - Web**
@@ -296,7 +296,7 @@ To add an image from the web, use the format `![alt text](image URL)`. The '!' a
296296
![alt text for screen readers](https://i.natgeofe.com/n/548467d8-c5f1-4551-9f58-6817a8d2c45e/NationalGeographic_2572187.jpg?w=1436&h=958)
297297
```
298298

299-
### Output
299+
**Output:**
300300
![alt text for screen readers](https://i.natgeofe.com/n/548467d8-c5f1-4551-9f58-6817a8d2c45e/NationalGeographic_2572187.jpg?w=1436&h=958)
301301

302302
**Images - Local**
@@ -309,19 +309,21 @@ Format: `![alt text](image path)`.
309309
![alt text for screen readers](cat_pic.png)
310310
```
311311

312-
### Output
312+
**Output:**
313313
![alt text for screen readers](cat_pic.png)
314314

315315
## 11. Escaping
316316
Sometimes, you might want to display special characters (like `*`, `_`, or `#`) in your text without them being interpreted as formatting. To do this, you can escape the character by placing a backslash (`\`) before it.
317317

318318
For example, if you want to display `*` before a word without it making the text italic, use `\*`.
319319

320-
Example:
320+
**Example:**
321321
`\*Not italicized\*`
322322

323-
### Output:
323+
**Output:**
324324
\*Not italicized\*
325325

326+
## Final Thoughts
327+
These are the basics of Markdown formatting, most often used when creating a `README.md` file. A `README.md` file explains the purpose, setup, and usage of a coding project. It serves as the project's main documentation and is usually the first thing users see in a repository. Every Git repository typically includes one, making Markdown a great way to document and showcase your work clearly and effectively.
326328

327-
329+
While `md` files support rich formatting, `README` can also be plain `txt` files, though they won't include formatting like headings or lists.

individual_modules/markdown_with_python/4-Markdown-Task-1.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ In this section, write a short paragraph explaining what the document is about o
1010
> Lorem ipsum dolor sit amet. At excepturi ipsam aut tempora fugit ut porro facilis et aspernatur totam vel voluptatem quisquam qui recusandae quidem. Ut facilis dolor et ipsum error et voluptates sint aut nesciunt inventore et delectus enim et quidem animi. Sed repellat deleniti id maiores temporibus ea doloremque fuga. Vel laboriosam galisum in corrupti vero qui inventore voluptatibus.
1111
1212

13-
Lorem Ipsum is meaningless placeholder text used in design and publishing to mimic the look of real written content without conveying any actual meaning. Use it here to practise applying the formatting features we’ve discussed.
13+
`Lorem Ipsum` is meaningless placeholder text used in design and publishing to mimic the look of real written content without conveying any actual meaning. Use it here to practise applying the formatting features we’ve discussed.
1414

1515
For example:
1616
* Use bold or italic formatting for emphasis.
@@ -19,7 +19,7 @@ For example:
1919

2020
2. Methods (`## Methods`)
2121

22-
Describe how Markdown works, you can use Lorem ipsum again.
22+
Describe how Markdown works, you can use `Lorem ipsum` again.
2323

2424
* Use an ordered list to explain the steps of opening a MD document.
2525
* Include examples of different text formatting like **bold text**.

individual_modules/markdown_with_python/5-How-to-embed-Python-Code-in-Markdown.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,11 +77,11 @@ import pandas as pd
7777

7878
Importing packages will give you access to external libraries like pandas, numpy or matplotlib. You may see an error when importing a package, this usually means the package isn't installed yet.
7979

80-
### Error Package Not Installed
80+
**Error Package Not Installed**
8181

8282
![Alt text](errorPack2.png)
8383

84-
### Solution
84+
**Solution**
8585
- Install package
8686
- in Jupyter Notebook: `!pip install pandas`
8787
- in a terminal: `pip install pandas`
@@ -201,7 +201,7 @@ Once you have executed this in a cell and the graph is displayed, have a play wi
201201

202202
Embedding Python in Markdown transforms static documents into interactive, dynamic tools that enhance data analysis, storytelling, and reproducibility.
203203

204-
## Note on Sensitive Data
204+
## Notes on Sensitive Data
205205
Before sharing or publishing your notebooks, ensure they do not contain any sensitive or restricted information. This includes:
206206

207207
- Personal identifiers (e.g. names, addresses, NHS numbers).

individual_modules/markdown_with_python/8-Further-Knowledge.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,5 +32,7 @@ import ipywidgets as widgets
3232
widgets.IntSlider(min=0, max=10, step=1, value=5)
3333
```
3434

35+
Try it on!
36+
3537
## Always remember!
3638
Clear structure, consistent naming, and clean outputs make notebooks easier to share and maintain.

0 commit comments

Comments
 (0)