Skip to content

Commit 2c3148d

Browse files
Merge pull request #274 from coding-for-reproducible-research/using-markdown-for-python-update
Remove incorrect section
2 parents e85027f + bb75b3e commit 2c3148d

File tree

5 files changed

+42
-22
lines changed

5 files changed

+42
-22
lines changed

_config.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,9 @@ exclude_patterns:
4040
- README.md
4141
- individual_modules/python_for_data_analysis/data-analysis-task-solutions.ipynb
4242

43+
parse:
44+
myst_enable_extensions: # default extensions to enable in the myst parser. See https://myst
45+
- strikethrough
4346

4447
# Execute all notebooks by default.
4548
# The R notebooks are excluded from running during the building of the book due to the formatting issues. When ran wen building the output for each of the cells will create a new code block for each space due to the R magic command.

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

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,23 +4,30 @@ Create a Markdown (`.md`) file with three sections: Introduction, Methods, and R
44

55
1. Introduction (`## Introduction`)
66

7-
In this section, write a short paragraph explaining what the document is about.
7+
In this section, write a short paragraph explaining what the document is about or add the text:
88

9+
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+
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.
14+
15+
For example:
916
* Use bold or italic formatting for emphasis.
10-
Include an unordered list (`- `or `*`) with at least two points explaining why Markdown is useful.
11-
Optionally, add a blockquote (`>`) to highlight an important point.
17+
* Include an unordered list (`- `or `*`) with at least two points explaining why Markdown is useful.
18+
* Optionally, add a blockquote (`>`) to highlight an important point.
1219

1320
2. Methods (`## Methods`)
1421

15-
Describe how Markdown works.
22+
Describe how Markdown works, you can use Lorem ipsum again.
1623

1724
* Use an ordered list to explain the steps of opening a MD document.
1825
* Include examples of different text formatting like **bold text**.
1926
* Add a code block (triple backticks ```).
2027

2128
3. Results (`## Results`)
2229

23-
Show the output of your research/experiment
30+
Show the output of your research/experiment.
2431

2532
* Use a table.
2633
* Use a task list

individual_modules/markdown_with_python/6-Export-the-Document.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,3 @@ When working with Jupyter Notebooks, it’s important to know how to save your w
2323
* They can be easily viewed in any web browser without requiring Jupyter or Python.
2424

2525
* To export, go to the menu: `File > Save and Export Notebook as > HTML (.html)`.
26-
27-
### 3. Exporting as PDF
28-
* Exporting as a PDF creates a document suitable for printing or formal sharing.
29-
30-
* Like HTML, it’s a static snapshot of your notebook with all visible code, text, and outputs.
31-
32-
* PDFs are widely accepted in academic and professional settings.
33-
34-
* Export via `File > Save and Export Notebook as > PDF via LaTeX (.pdf)`.

individual_modules/markdown_with_python/LICENSE.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### Instructional Material
22

3-
The instructional material in this course is copyright © 2024 University of Exeter
3+
The instructional material in this course is copyright © 2025 University of Exeter
44
and is made available under the Creative Commons Attribution 4.0 International
55
licence (https://creativecommons.org/licenses/by/4.0/). Instructional material
66
consists of material that is contained within the "individual_modules/markdown_with_python" folders in
@@ -14,7 +14,7 @@ considered software for the purposes of this licence.
1414
Except where otherwise noted, software provided in this repository is made
1515
available under the MIT licence (https://opensource.org/licenses/MIT).
1616

17-
Copyright © 2024 University of Exeter
17+
Copyright © 2025 University of Exeter
1818

1919
Permission is hereby granted, free of charge, to any person obtaining a copy
2020
of this software and associated documentation files (the "Software"), to deal
@@ -37,7 +37,7 @@ SOFTWARE.
3737
The software in this repository is adapted from software that is covered by the
3838
following copyright and permission notice:
3939

40-
Copyright © 2024 Software Carpentry
40+
Copyright © 2025 Software Carpentry
4141

4242
Permission is hereby granted, free of charge, to any person obtaining
4343
a copy of this software and associated documentation files (the

programme_information/markdown_with_python.ipynb

Lines changed: 24 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,13 @@
33
{
44
"cell_type": "markdown",
55
"id": "4af966b6-fcee-46c4-9fc5-2f2b6a839ac2",
6-
"metadata": {},
6+
"metadata": {
7+
"editable": true,
8+
"slideshow": {
9+
"slide_type": ""
10+
},
11+
"tags": []
12+
},
713
"source": [
814
"# Using Markdown for Python\n",
915
"\n",
@@ -30,9 +36,14 @@
3036
"\n",
3137
"- Prerequisite Course: Complete the [\"Introduction to Python\"](https://coding-for-reproducible-research.github.io/CfRR_Courses/programme_information/intro_to_python.html) course. \n",
3238
"\n",
33-
"- Software and Requirements (optional): Install JupyterLab, ensuring Python and pip are set up on your system. Follow the installation instructions on the above-mentioned CfRR website. \n",
39+
"## Installation guide\n",
40+
"\n",
41+
"- All CfRR courses require attendees to use their own computer/laptop to follow workshop activities and take effective notes.\n",
42+
"\n",
43+
"- Install JupyterLab, ensuring Python and pip are set up on your system. Follow the [installation instructions](https://coding-for-reproducible-research.github.io/CfRR_Courses/programme_information/intro_to_python.html) on the CfRR website.\n",
44+
"\n",
45+
"- Markdown in JupyterLab: No additional installation is needed for basic Markdown support in JupyterLab.\n",
3446
"\n",
35-
"- Markdown in JupyterLab: No additional installation needed for basic Markdown support in JupyterLab. \n",
3647
"\n",
3748
"## Self Study Material Link \n",
3849
"\n",
@@ -50,7 +61,15 @@
5061
"cell_type": "code",
5162
"execution_count": 1,
5263
"id": "692259f5-5cdf-42d7-8746-7d24579073d0",
53-
"metadata": {},
64+
"metadata": {
65+
"editable": true,
66+
"slideshow": {
67+
"slide_type": ""
68+
},
69+
"tags": [
70+
"remove-input"
71+
]
72+
},
5473
"outputs": [
5574
{
5675
"data": {
@@ -166,7 +185,7 @@
166185
"name": "python",
167186
"nbconvert_exporter": "python",
168187
"pygments_lexer": "ipython3",
169-
"version": "3.9.19"
188+
"version": "3.9.6"
170189
}
171190
},
172191
"nbformat": 4,

0 commit comments

Comments
 (0)