Skip to content

Latest commit

 

History

History
110 lines (89 loc) · 7.59 KB

learn_markdown.md

File metadata and controls

110 lines (89 loc) · 7.59 KB
Raw
layout title nav_order
default
Learn Markdown
5

Lesson 2: Learn Markdown

One of the really nice things about GitHub (and GitHub Pages, which you'll learn about later) is that you can use Markdown to format text on a web page without the use (or knowledge!) of HTML coding. This makes it really easy to create content. In this section, you'll learn a bit more about Markdown and how to use it to create formatted text.

Lesson video

The following video demonstrates each of the steps outlined below in text:

<iframe height="480" width="853" allowfullscreen frameborder=0 src="https://echo360.ca/media/ba194214-c372-4df6-b74d-2cdf8157f996/public?autoplay=false&automute=false"></iframe>

Lesson objectives

  • Learn about Markdown
  • Practice creating web-ready content with Markdown
  • Learn how to create special symbols and equations using HTML code

1. What is Markdown?

Borrowed shamelessly from GitHub's Mastering Markdown page:

Markdown is a way to style text on the web. You control the display of the document; formatting words as bold or italic, adding images, and creating lists are just a few of the things we can do with Markdown. Mostly, Markdown is just regular text with a few non-alphabetic characters thrown in, like # or *.

Markdown uses simple notation to apply simple formatting rules. Since it's pretty much just plain text, it's transferrable and much simpler than marked-up text like HTML or even Word or Google documents. It's also very readable in its plain text format, which is nice. For much of the writing that you do for the web, Markdown is good enough. GitHub uses Markdown for its documents (this document was created in markdown), as does a variety of other web platforms (Reddit and Trello, as examples).

2. Add content to index.md

Add a title and front matter

In Lesson 3, you will use GitHub Pages and a program called jekyll to turn your markdown files into web pages. In preparation for this, you will want to add some front matter to your markdown file. Front matter provides information about the web page's presentation and structure (title, layout, page order in a list, etc.).

  • Open your index.md file for editing. Remove any text that was in there from Lesson 1.
  • Using the GitHub editor, copy the text below and paste it at the top (including the dashes):
---
title: <enter your title here>
layout: default
nav_order: 1
---

Don't worry if this information looks a bit weird when you preview the page--it won't appear on your final web page.

3. Use Markdown to add content to index.md

Using the Mastering Markdown guide and/or markdownguide.org's Basic Syntax Guide (or other guides you find on the web) as a reference, enter text beneath the front matter to create a fictional document that contains most of the following elements:

  • Headings of a number of different levels
  • bolded, italicized text
  • insert an image from the web
  • insert the image that you uploaded to the images folder in this repository
  • An ordered list
  • A bulleted list
  • A link to another website
  • A snippet of code
  • A table
  • And finally, an emoji! (you can use the Markdown Emoji cheat sheet as a reference)

Some Notes

  • Use the Preview changes tab to see (mostly) how it will look on your page.
  • Markdown doesn't add new lines to a document in the same way as a document editors like MS Word. Sometimes you might hit enter to start a new line in the editor, only to find that it has been added to the first paragraph when rendered. To avoid this you can try one of the following:
    • Enter an extra blank line
    • Leave two blank spaces at the end of the sentence (this is interpretted as the end of a paragraph)
    • Insert the HTML tag <br> to create a break line in the rendered text. You can use multiple break tags to create more blank lines.

**Commit your changes** and enjoy the products of your hard work!

4. Create a second markdown page

The website you make in the next lesson will have two pages. Here, you are going to create the second page.

  • In the top level of your repository (remember, you can click the <> Code tab to get there), create a new markdown file. Name it as you wish, but ensure that it is free of spaces and special characters and ends in .md (e.g. pagetwo.md works just fine).
  • As done earlier, add front matter with a title. Set the nav_order value to 2 (this will inform GitHub Pages to make this the second menu item in your website), as shown below:
---
title: <enter a different title here>
layout: default
nav_order: 2
---
  • Add a few sentences and commit your changes.

5. [Optional] Adding scientific symbols and equations

While the simplicity of Markdown is usually an asset, there are times when you need to present text using more complex formatting--for example, when using symbols and equations. Given that these pieces aren't baked into Markdown, you'll need to resort to using HTML coding. This involves a bit more technical skill, but it's something that you can figure out pretty quickly with the help of Google.

Symbols

The W3schools HTML Symbols reference page is the best place to go for comprehensive instruction on adding symbols using HTML. It also provides a variety of symbol lists for easy reference.

As discussed in the previous resource, you can use an entity name or an entity number to create a symbol. For example, to create the alpha symbol, you can do either of the following:

  • Entering the entity name &alpha; will print the symbol α, OR
  • Entering the entity number &#945; will print the symbol α

Note: Don't forget the semicolon at the end of the code!

Subscripts and superscripts

Subscripts and superscripts can be created by putting placing the following HTML tags before and after the desired numerals/symbols:

  • For subscripts, place <sub> in front and </sub> after the character(s) you would like to subscript.
    • e.g. H<sub>2</sub>O produces H2O
  • For superscripts, place <sup> in front and </sup> after the character(s) you would like to superscript.
    • e.g. &delta;<sup>18</sup>O produces δ18O

Single-line equations

Single-line equations can be created by combining symbols and sub/superscripts as required.

  • e.g. h<sub>&theta;</sub>(x) = &theta;<sub>o</sub> x + &theta;<sub>1</sub>x produces hθ(x) = θo x + θ1x

Create some symbols/equations

  • Open your second markdown page for editing, and write a few symbols and an equation or two.
  • Commit your changes

More complex equations (in case you're interested)

If you require a more complex equation, it's probably easiest to insert the equation as an image. There are some interesting ways to do this dynamically using Latex if you're interested in exploring. You can find more information on these approaches in this Stack Overflow answer.

Mastered Markdown? It's time to move to Lesson 3 and make a website with GitHub Pages!