Overview - BrandonGoff/communicate-using-markdown GitHub Wiki
%%{init: { 'logLevel': 'debug', 'theme': 'forest' } }%%
timeline
title Communicate Using Markdown
section Getting Started
SETUP : Read the information in the wiki
: Make sure you can access the project in this repo we will be using today
: Open the project item you will use to post your work in while completing this course
section Activity Walkthrough <br> Using Markdown and GitHub Projects
Step 1) <br> Add headers
: 1.1) Open another new browser tab and navigate to the instructions for this course on the "<>Code" tab of this repo (this way you have a tab for viewing instructions and another for working in).
: 1.2) Move your project item from "Getting Started" to "In Progress"
: 1.3) Read the example shown in Step 1 of the course
: 1.4) Add a h1, h2, and h6 header to your item in the project
: 1.5) Preview your work to make sure your headers display correctly
Step 2) <br> Add an image
: 2.1) Read the example shown in Step 2
: 2.2) Search the internet for an image you would like to add to your project item
: 2.3) Click the image you would like to add and press " Ctrl+C " to copy the image
: 2.4) Click the area in your project item where you would like your image to appear
: 2.5) Press " Ctrl+V " to paste your image in the markdown text
: 2.6) Check to make sure your markdown notation matches the example
: 2.7) Preview your image to make sure it displays correctly
Step 3) <br> Add a code example
: 3.1) Read the example shown in Step 3
: 3.2) Search the internet for a snippet of code (or write your own) to display
: 3.3) Copy your code snippet and paste it below your image
: 3.4) Make three backticks (usually found above the tab key in the top left of your keyboard) above and below your snippet.
: 3.5) Check the example to make sure your markdown notation matches
: 3.6) Preview your code to make sure it displays correctly
Step 4) <br> Make a task list
: 4.1) Read the example shown in Step 4
: 4.2) Below your code snippet make a task list
: 4.3) Preview your list to make sure it displays correctly
: 4.4) Move your project item to "In Review"