Markdown

Markdown Classwork

The benefit of using Atom as your Markdown editor is that it comes with pre-installed plugins for Markdown: ‣ Language-Markdown (which highlights syntax), ‣ and Markdown-preview (which allows you to view a real-time preview of your Markdown product).

Step 1: Open Atom and locate your repository on your hard drive (which you created this in week 2 and called it something like "[username]/HIST4006"). In this repository there should be two folders: one entitled "Classwork" and the other "Folios." Open the HIST4006 repository, then the Classwork folder (which should be visible in the sidebar). In this folder, you will find a file called Sample.Kate.profile.md. Open it and you will see a file that looks like this:

# This is Kate's Markdown file
***
Here is a list of reasons I joined HIST 4006A:

- improve my __digital humanities skills__
- learn _more_ about codicology and palaography
- make an **online project** I can put on my CV
- meet *awesome* medievalists

### More about me
Here is a link to [my Hcommons profile](https://hcommons.org/members/katebrasseur/)

Here are four emoticons that represent me:

1. :european_castle:
2. :cat2:
3. :cherry_blossom:
4. :rainbow:

Step 2: In Atom, click File >> Save As... and save the renamed file in the Classwork folder using the following naming convention:

Your last name.your first name.profile.md

Step 3: Navigate to the Packages tab and select Markdown Preview >> Toggle Preview to see a live preview of your Markdown in action. In a new column, you should see the code translated to the visual appearance of the Markdown file.

Step 4: Replace the example text with your own, check to make sure you get the syntax correct by checking the Markdown Preview. Once you are satisfied with your work, learn how to contribute the file to our repository on Github in the next lesson.

Last updated