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: individual_modules/markdown_with_python/3-Markdown-Fundamentals.md
+24-22Lines changed: 24 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -93,7 +93,7 @@ A line break within a paragraph is created by adding two spaces at the end of a
93
93
94
94
To create a full paragraph break (a blank line between paragraphs), you simply press Enter twice.
95
95
96
-
Here is an example:
96
+
Here is **an example:**
97
97
98
98
```
99
99
This is the first paragraph.
@@ -102,7 +102,7 @@ This is the second paragraph with a
102
102
line break inside.
103
103
```
104
104
105
-
### Output:
105
+
**Output:**
106
106
This is the first paragraph.
107
107
108
108
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
133
133
### Unordered Lists (Bullets)
134
134
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.
135
135
136
-
Example:
136
+
**Example:**
137
137
```
138
138
- Item 1
139
139
- Item 2
@@ -142,7 +142,7 @@ Example:
142
142
143
143
```
144
144
145
-
### Output:
145
+
**Output:**
146
146
- Item 1
147
147
- Item 2
148
148
- Subitem 2.1
@@ -159,7 +159,7 @@ To make a numbered list, just start each line with a number followed by a full s
159
159
2. Subitem 2.2
160
160
```
161
161
162
-
### Output:
162
+
**Output:**
163
163
1. First item
164
164
2. Second item
165
165
1. Subitem 2.1
@@ -172,14 +172,14 @@ Task lists are useful when you want to show items that need to be completed —
172
172
- to make an unchecked box, use `- []`.
173
173
- to make a checked box, use `- [x]`.
174
174
175
-
Example:
175
+
**Example:**
176
176
```
177
177
- [ ] Task 1
178
178
- [x] Task 2
179
179
180
180
```
181
181
182
-
### Output:
182
+
**Output:**
183
183
184
184
-[ ] Task 1
185
185
-[x] Task 2
@@ -192,13 +192,13 @@ Blockquotes are used to highlight quotes, important information, or notes in you
192
192
193
193
To create a blockquote, start a line with a `>` symbol. If you want to create a nested blockquote (a quote inside a quote), use `>>`.
194
194
195
-
Example:
195
+
**Example:**
196
196
```
197
197
> This is a blockquote.
198
198
>> This is a nested blockquote.
199
199
```
200
200
201
-
### Output:
201
+
**Output:**
202
202
> This is a blockquote.
203
203
>> This is a nested blockquote.
204
204
@@ -211,27 +211,27 @@ Markdown makes it easy to format code, whether it's a single line or multiple li
211
211
212
212
To format a short piece of code inline, wrap it in single backticks (`).
213
213
214
-
Example:
214
+
**Example**:
215
215
```
216
216
Use the `print()` function in Python.
217
217
```
218
218
219
-
### Output:
219
+
**Output:**
220
220
Use the `print()` function in Python.
221
221
222
222
223
223
### Code Blocks
224
224
225
225
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.
226
226
227
-
Example:
227
+
**Example**:
228
228
```
229
229
```python
230
230
def greet():
231
231
print("Hello, World!")
232
232
```
233
233
234
-
### Output:
234
+
**Output:**
235
235
236
236
```python
237
237
defgreet():
@@ -252,7 +252,7 @@ Tables help make data clearer and more structured, especially when you need to p
252
252
253
253
```
254
254
255
-
### Output
255
+
**Output:**
256
256
257
257
| Name | Age | Job |
258
258
|-------|-----|----------|
@@ -268,7 +268,7 @@ Horizontal lines are used to separate sections of your document, providing a cle
268
268
---
269
269
```
270
270
271
-
### Output
271
+
**Output:**
272
272
---
273
273
274
274
@@ -280,12 +280,12 @@ Adding links and images is a great way to enrich your documents. In Markdown, ad
280
280
281
281
To create a link, use the format `[text](URL)`. This will display the text as a clickable link that directs to the specified URL.
282
282
283
-
Example:
283
+
**Example:**
284
284
```
285
285
[Link text](https://www.exeter.ac.uk/)
286
286
```
287
287
288
-
### Output
288
+
**Output:**
289
289
[Link text](https://www.exeter.ac.uk/)
290
290
291
291
**Images - Web**
@@ -296,7 +296,7 @@ To add an image from the web, use the format ``. The '!' a
296
296

297
297
```
298
298
299
-
### Output
299
+
**Output:**
300
300

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.
317
317
318
318
For example, if you want to display `*` before a word without it making the text italic, use `\*`.
319
319
320
-
Example:
320
+
**Example:**
321
321
`\*Not italicized\*`
322
322
323
-
### Output:
323
+
**Output:**
324
324
\*Not italicized\*
325
325
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.
326
328
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.
Copy file name to clipboardExpand all lines: individual_modules/markdown_with_python/4-Markdown-Task-1.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ In this section, write a short paragraph explaining what the document is about o
10
10
> 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.
11
11
12
12
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.
14
14
15
15
For example:
16
16
* Use bold or italic formatting for emphasis.
@@ -19,7 +19,7 @@ For example:
19
19
20
20
2. Methods (`## Methods`)
21
21
22
-
Describe how Markdown works, you can use Lorem ipsum again.
22
+
Describe how Markdown works, you can use `Lorem ipsum` again.
23
23
24
24
* Use an ordered list to explain the steps of opening a MD document.
25
25
* Include examples of different text formatting like **bold text**.
Copy file name to clipboardExpand all lines: individual_modules/markdown_with_python/5-How-to-embed-Python-Code-in-Markdown.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -77,11 +77,11 @@ import pandas as pd
77
77
78
78
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.
79
79
80
-
### Error Package Not Installed
80
+
**Error Package Not Installed**
81
81
82
82

83
83
84
-
### Solution
84
+
**Solution**
85
85
- Install package
86
86
- in Jupyter Notebook: `!pip install pandas`
87
87
- 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
201
201
202
202
Embedding Python in Markdown transforms static documents into interactive, dynamic tools that enhance data analysis, storytelling, and reproducibility.
203
203
204
-
## Note on Sensitive Data
204
+
## Notes on Sensitive Data
205
205
Before sharing or publishing your notebooks, ensure they do not contain any sensitive or restricted information. This includes:
206
206
207
207
- Personal identifiers (e.g. names, addresses, NHS numbers).
0 commit comments