Skip to content

Commit 2d85654

Browse files
author
protohedgehog
committed
Added markdown tips
1 parent c1e959b commit 2d85654

File tree

2 files changed

+69
-13
lines changed

2 files changed

+69
-13
lines changed

content_development/Task_1.md

Lines changed: 69 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -24,27 +24,83 @@ Don't forget you can join in the discussions over at our open [**Slack channel**
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

27-
In order to help this, we are going to try something that hasn't really been done before. This MOOC 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.
27+
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-
Throughout these tasks, we will help you to directly create and edit content that becomes part of this MOOC and its companion website. What you do from here on out will directly 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+
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.
3030

3131
**IMPOSTER SYNDROME KLAXON**
3232

33-
Scholarly researchers represent the highest density of Imposter Syndrome that has ever been known to exist in the history of anything, ever. [ADD SOME DUBIOUS LINK/CITATION HERE]
33+
Scholarly researchers represent the highest density of Imposter Syndrome that has ever been known to exist in the history of virtually anything, ever. [Jacquelyn Gill](https://twitter.com/JacquelynGill) wrote an excellent [post](https://contemplativemammoth.com/2012/04/25/how-i-cured-my-imposter-syndrome/) on this issue several years back now, and is well worth reading if you have a few minutes to spare before moving on.
3434

35-
<br/>
36-
37-
## Learning how to use markdown<a name="markdown"></a>
38-
39-
A lot of people think RStudio 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. Much of this MOOC was written in markdown, and look how nice it all looks!
35+
> "While imposter syndrome can be alienating and the source of unhealthy emotional turmoil, I do think it’s worth drawing a clear line between feeling inadequate and recognizing areas for improvement. Being immobilized by anxiety because you don’t have a background in math is one thing; identifying a gap in your skill set and setting out to work on that is another. This takes time, a lot of self-reflection, and is best done with a good mentor or three." - Jacquelyn Gill.
4036
41-
[insert tumbleweed gif]
37+
We want to remind you at the beginning that if you find any part of this MOOC complicated, frustrating, or difficult, that is totally okay. The whole point of having this more of a peer-to-peer community is foster a culture of mutual understanding and learning so that we all grow together. The fact that you are here, demonstrating a willingness to learn more, is what is most important at this stage. We all have gaps in our knowledge and understanding, and this MOOC is just one small way to fill some of those gaps. So, we **thank you** for being here!
4238

43-
Markdown is really a simple formatting 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.
44-
45-
Here is some basic markdown syntax that might be handy here:
39+
<br/>
4640

47-
[INSERT SOME BASIC MARKDOWN SYNTAX HERE]
41+
## Learning how to use markdown <a name="markdown"></a>
42+
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!
44+
45+
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.
46+
47+
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.
48+
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)):
50+
51+
`# Header one
52+
## Header two
53+
### Header three
54+
#### Header four
55+
56+
Header with an underline
57+
========================
58+
59+
Or different underline style
60+
----------------------------`
61+
62+
`*one asterisk pair for italics*
63+
**two asterisk pairs for bold**
64+
_you can also use underscores for bold_
65+
*_to do things like this_*
66+
~~two tildes for strikethrough~~
67+
68+
1. For a numbered list
69+
2. Just use numbers
70+
3. Like this
71+
72+
73+
* For an unordered list
74+
* Just use asterisks
75+
* Like this
76+
77+
1. Unordered
78+
2. And ordered
79+
* Lists can also be
80+
* Combined
81+
3. Like this`
82+
83+
For automatic links use `[square brackets](https://www.google.com)` and then insert the target URL in normal brackets after.
84+
85+
For images, use an exclamation to indicate this and then a link to the image location:
86+
`![image](https://github.com/OpenScienceMOOC/Module-1-Open-Principles/blob/master/content_development/images/logo.png)`
87+
88+
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:
89+
90+
`<p align="center"><img src="https://github.com/OpenScienceMOOC/Module-1-Open-Principles/blob/master/content_development/images/logo.png?raw=true" width="600" /></p>
91+
92+
<p align="center"><i>The Open Science MOOC logo!</i></p>`
93+
94+
Some times, you might want to add in little snippets of code, like we have done above. For this, use simple back ticks:
95+
96+
`some code with back-ticks around it`
97+
98+
For code blocks or chunks, you can use three back-ticks to indicate these:
99+
100+
```python
101+
s = "Python syntax highlighting"
102+
print s
103+
```
48104

49105
<br/>
50106

152 KB
Loading

0 commit comments

Comments
 (0)