World map

 

BM

World 5: Teamwork

Markdown basics

You will learn: how to write headings, lists, links and code in Markdown.

The problem

This README is full of odd signs: #, ** and -. Are they typos? No! They are secret formatting codes.

Watch

Practice repo — not a real website
kelab-kod / club-site
README.md · 13 lines

Club Site

The website for our school code club.

Get started

  1. Download the files.
  2. Open index.html in your browser.

Links

Same file, on GitHub. It reads the signs and draws a neat page. This way of writing is called Markdown: Plain text with simple signs, like # for a heading. GitHub turns it into a neat page..

Try it

A heading starts with #. One # makes the biggest. Make “Code Club” a big title. Make “What we do” a smaller one.

Put # before Code Club. Put ## before What we do.

Preview

Code Club

We meet every Friday.

What we do

We build fun websites.

0 of 2 goals done

Predict

You type **Friday**. How does it look on the page?

Try it

A dash and a space start a list item. Turn the two plain lines into a list.

Start each of the last two lines with a dash and a space.

Preview

Code Club

Things we need:

Laptops Snacks

0 of 2 goals done

Check

A link is [text](address). Code goes between backticks. Good Markdown, or needs work?

Swipe right for good, left for needs work. Or use the buttons.

1 / 4[How to help](CONTRIBUTING.md)

Check

Which sign makes what? Sort each line.

Drag a card into a box. Or tap the card, then tap the box.

        You did it!

        You can now write headings, lists, links and code in Markdown.

        Go deeper (optional)

        One star on each side makes italic. Two tildes make strikethrough. A line starting with > makes a quote. Three backticks on their own lines make a code block. Type @name to mention someone, or #12 to link issue 12. With two or more headings, GitHub builds an outline menu for the file.