Skip to content

Commit 435044d

Browse files
author
protohedgehog
committed
More updates to syntax
1 parent e3e7e36 commit 435044d

File tree

2 files changed

+166
-47
lines changed

2 files changed

+166
-47
lines changed

content_development/Task_1.html

Lines changed: 119 additions & 14 deletions
Large diffs are not rendered by default.

content_development/Task_1.md

Lines changed: 47 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -14,19 +14,19 @@ Don't forget you can join in the discussions over at our open [**Slack channel**
1414

1515
## Table of contents
1616

17-
* [Getting started](#Getting_started)
18-
* [Learning how to use markdown](#markdown)
17+
* [Getting started up](#Getting_started)
18+
* [Learning the basics of markdown syntax](#markdown)
1919
* [](#)
2020
* [BONUS STEP](#bonus)
2121

2222

23-
## Getting started <a name="Getting_started"></a>
23+
## Getting started up <a name="Getting_started"></a>
2424

2525
Welcome to your first task, probably, of the Open Science MOOC! What we *don't* want here is to create something were you sit in front of a screen, basically being lectured like you do at high school or university. We want you to create, to learn, to build, both as an individual and as part of a boundless community. We want to help you to sculpt your own path in research, and tell your own story and use that story to inspire and guide others.
2626

2727
In order to help this, we are going to try something that hasn't really been done before in this space. This [MOOC](https://opensciencemooc.eu/) is entirely built on a dynamic 'open source' process, with everything in the open and available to contribution from everyone. We would like you to be part of that.
2828

29-
Duing the tasks throughout the MOOC modules, we will help you, as a community, to directly create and edit content that becomes part of the overall course and its companion website. What you do from here on out will help to influence the learning of all individuals who come here in the future. Our job is to guide you in this process, and help you to realise that what you are doing is valuable, to yourself and others.
29+
During the tasks throughout the MOOC modules, we will help you, as a community, to directly create and edit content that becomes part of the overall course and its companion website. What you do from here on out will help to influence the learning of all individuals who come here in the future. Our job is to guide you in this process, and help you to realise that what you are doing is valuable, to yourself and others.
3030

3131
**IMPOSTER SYNDROME KLAXON**
3232

@@ -38,21 +38,24 @@ We want to remind you at the beginning that if you find any part of this MOOC co
3838

3939
<br/>
4040

41-
## Learning how to use markdown <a name="markdown"></a>
41+
## Learning the basics of markdown syntax <a name="markdown"></a>
4242

43-
A lot of people think [RStudio](https://www.rstudio.com/) (covered more in [Module 5](https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/MAIN.md)) is just for writing complex scripts for statistical analysis. Wrooooong. It can also be used to write nicely formatted text documents, using something called [markdown](https://en.wikipedia.org/wiki/Markdown). Much of this MOOC was written in markdown, and then converted from that into PDF, HTML, and Jupyter notebook formats, and look how nice it all looks!
43+
A lot of people think [RStudio](https://www.rstudio.com/) (covered more in [Module 5](https://github.com/OpenScienceMOOC/Module-5-Open-Research-Software-and-Open-Source/blob/master/content_development/MAIN.md)) is just for writing complex scripts for statistical analysis. Wrooooong. It can also be used to write nicely formatted text documents, using something called [markdown](https://en.wikipedia.org/wiki/Markdown). Much of this MOOC was written in markdown in RStudio, and then converted from that into PDF, HTML, and Jupyter notebook formats, and look how nice it all looks!
4444

4545
Markdown is really a plain writing style that gives you full control over the format of text. If you're used to using something like Microsoft Word, it's kind of similar and gives you the same control over simple things like header style and text format. But in a way that is readable by more software, and can also be easily easily rendered as a webpage and many other useful output formats.
4646

4747
It is because markdown is so flexible in reading, writing, and conversion, that we are going to be learning a bit about it to get things started here. A collection of all things markdown-related can also be found [here](https://github.com/mundimark/awesome-markdown) for the adventurous types.
4848

49-
Here is some basic markdown syntax that you might find handy for now (based largely on this [cheatsheet from Adam Pritchard](https://github.com/adam-p/markdown-here/wiki/Markdown-Here-Cheatsheet)):
49+
Here is just some of the basic markdown syntax that you might find handy for now (based largely on this [cheatsheet from Adam Pritchard](https://github.com/adam-p/markdown-here/wiki/Markdown-Here-Cheatsheet)):
5050

5151
```markdown
5252

5353
# Header one
54+
5455
## Header two
56+
5557
### Header three
58+
5659
#### Header four
5760

5861
Header with an underline
@@ -70,20 +73,14 @@ Here is some basic markdown syntax that you might find handy for now (based larg
7073
* Just use asterisks (*)
7174
* Like this
7275

73-
1. Unordered
74-
2. And ordered
75-
* Lists can also be
76-
* Combined
77-
3. Like this
78-
* Using tabs
79-
* To set the different
80-
* List levels
81-
8276
```
83-
77+
8478
# Header one
79+
8580
## Header two
81+
8682
### Header three
83+
8784
#### Header four
8885

8986
Header with an underline
@@ -98,26 +95,15 @@ Here is some basic markdown syntax that you might find handy for now (based larg
9895
3. Like this
9996

10097
* For an unordered list
101-
* Just use asterisks (*)
98+
* Just use asterisks
10299
* Like this
103100

104-
1. Unordered
105-
2. And ordered
106-
* Lists can also be
107-
* Combined
108-
3. Like this
109-
* Using spaces
110-
* To set the different
111-
* List levels
112-
113101
For automatic links use [square brackets](https://www.google.com) and then insert the target URL in normal brackets after.
114102

115103
`[square brackets](https://www.google.com)`
116104

117105
For images, use an exclamation to indicate this and then a link to the image location:
118106

119-
![image](https://github.com/OpenScienceMOOC/Module-1-Open-Principles/blob/master/content_development/images/logo.png)
120-
121107
`![image](https://github.com/OpenScienceMOOC/Module-1-Open-Principles/blob/master/content_development/images/logo.png)`
122108

123109
Some times you can also add in bits of HTML here if you want to be a bit fancier, which can help with display issues too some times:
@@ -126,11 +112,12 @@ Some times you can also add in bits of HTML here if you want to be a bit fancier
126112

127113
<p align="center"><i>The Open Science MOOC logo!</i></p>
128114

129-
`<p align="center"><img src="https://github.com/OpenScienceMOOC/Module-1-Open-Principles/blob/master/content_development/images/Logo.png?raw=true" width="500" /></p>
130-
131-
<p align="center"><i>The Open Science MOOC logo!</i></p>`
115+
```markdown
116+
<p align="center"><img src="https://github.com/OpenScienceMOOC/Module-1-Open-Principles/blob/master/content_development/images/Logo.png?raw=true" width="500" /></p>
132117

133-
Some times, you might want to add in little snippets of code, like we have done above. For this, use simple back ticks:
118+
<p align="center"><i>The Open Science MOOC logo!</i></p>
119+
```
120+
Some times, you might want to add in little snippets of code, like we have done above. For this, use simple back ticks, these little things: `
134121

135122
`some code with back-ticks around it`
136123

@@ -141,6 +128,33 @@ s = "Python syntax highlighting"
141128
print s
142129
```
143130

131+
Another handy point for highlighting text is to use block quotes, especially if you want to add a direct quote from someone (like we did for Jacquelyn above). For this, just use a right line break: >
132+
133+
`> This is a quote (Person, 2018)`
134+
135+
> This is a quote (Person, 2018)
136+
137+
For simplicity, line breaks are best added using the simple html code: `<br/>` as this helps to keep it much more visible where they are or need adding.
138+
139+
One of the last little things we might want to do is add tables, as these can look quite nifty in markdown. Let's sketch out a simple one here and see what it looks like.
140+
141+
```markdown
142+
143+
| Column 1 | Column 2 | Column 3 |
144+
| -------------|:-------------:| ---------:|
145+
| Tyrannosaurus| Meat | Angry |
146+
| Velociraptor | Meat | Relaxed |
147+
| Triceratops | Veggiesaurus | Hungry |
148+
149+
```
150+
Notice how the colons are used to align the text in the columns to either the centre or right hand side?
151+
152+
| Column 1 | Column 2 | Column 3 |
153+
| -------------|:-------------:| ---------:|
154+
| Tyrannosaurus| Meat | Angry |
155+
| Velociraptor | Meat | Relaxed |
156+
| Triceratops | Veggiesaurus | Hungry |
157+
144158
<br/>
145159

146160
## Putting this into practise<a name="draft"></a>

0 commit comments

Comments
 (0)