Skip to content

Latest commit

 

History

History
176 lines (124 loc) · 4.25 KB

00a-markdown.md

File metadata and controls

176 lines (124 loc) · 4.25 KB
Raw

Mastering Markdown

Objective

  • It is relevant to learn Markdown so the pre-work can be submitted in an easy-to-read format.
  • During the bootcamp, you will create a blog on an open source tool and the blogs will be written in Markdown
  • Furthermore, markdown will serve as a great starting point to learning LaTeX which is used to make gorgeous documents used in academic publications. If you aren't interested in LaTeX, knowledge of markdown will also prepare you to use software like Typora - which fuses markdown with LaTeX and other writing packages.

Instructions

Read this document and use the Markdown syntax to write up your pre-work solutions.

Deliverable

Markdown syntax will be seen in subsequent pre-work file submissions.

Typora is a fantastic free software that renders your markdown in realtime as you type. You can also write markdown in any text editor and preview it on github.

Important: Look at your rendered markdown file before submitting! 💥

Introduction

What Is Markdown? 4 Reasons Why You Should Learn It Now

Markdown is a simple way to add formatting — like headers, bold/italic text, and lists — to plain text. Rather than relying on HTML or WYSIWYG editors, Markdown allows you to create full pages of formatted text without ever having to remove your fingers from the keyboard, and all in a way that’s much more intuitive than HTML.

Table of Contents

1) Line Breaks
2) Text Formatting
3) Referencing Other Markdown Files
4) Horizontal Rules
5) Emoji's
6) Links
7) Block Code, Language-specific
8) Tables
References

1) Line Breaks

How to add line breaks:

  1. add two spaces to end of line**
  2. enclose text in triple back quotes

2) Text Formatting

bold: **bold** bold
italic: *italic* italic
italic: _italic_ italic

3) Referencing Other Markdown Files

In a markdown file on GitHub, to see how it was formatted, click on "raw" on upper right corner.

4) Horizontal Rules

Code for line separators:

Rule #1 
---
Rule #2
*******
Rule #3
___

Rendered code for line separators:

Rule #1

Rule #2

Rule #3

5) Emoji's

Code for emoji's:

:fireworks:
:smiley:
:watermelon:

Rendered emoji's:
🎆
😃
🍉

6) Links

Text for link:
Here's an inline link to [Google](http://www.google.com/).
Rendered link:
Here's an inline link to Google.

7) Block Code, Language-specific

python

Block code that is non-specific:

print "hello world!"
print "hello moon"

Block code that is python-specific:

print("hello world!")
print("hello moon")

bash or console

Block code that is non-specific:

$ git status
$ git remote -v

Block code that is bash-specific:

$ git status
$ git remote -v

$ ps awx | grep mongo

sql

Block code that is non-specific:

SELECT * FROM Customers WHERE Country='Sweden';

Block code that is sql-specific:

SELECT * FROM Customers WHERE Country='Sweden';

Yes, this works for scores of other languages: Syntax highlighting in markdown

8) Tables

First Header | Second Header
------------ | -------------
Content from cell 1 | Content from cell 2
Content in the first column | Content in the second column
First Header Second Header
Content from cell 1 Content from cell 2
Content in the first column Content in the second column

References

Markdown Help