Home - BrandonGoff/communicate-using-markdown GitHub Wiki

Welcome!

A Quick recap:

If you are totally new to GitHub make sure to check out my take on the GitHub Skills 'Intro to GitHub' course Here.

We review the basic concepts like repositories, commits, pull requests, and merges. This is also a good resource to have available to help remind you how to get around when using the features or editing the content of a GitHub repository. Once you understand these features of your GitHub repository there really isn't anything keeping you from diving right into the world of creativity that is the GitHub community.

However, there are a few things that would really make our lives easier. Like what if we need to write a checklist of items on a complicated issue? What if I want to click on my screenshot of a webpage and be linked straight to that page? And how do these other developers post such beautiful and easy to work with code snippets in their comments?

In order to step up our GitHub game to the next level we are going to need the power of....

🎉** GitHub flavored Markdown **🎉

Markdown:

Before learning how we are going to use Markdown to make the most of our communication, lets first get a good understanding of what Markdown is in the first place. Before moving on to our activities for the day, head over to the What is Markdown? page and get a good idea of what we are going to be learning about.

Go ahead and do this now before moving on....

GitHub Projects:

The main focus of this course is on using Markdown in GitHub, but there are many other very useful features available to us here in GitHub. Again we will be tailoring this course a bit for us all to practice working together as a group so instead of adding files with branches and pull requests we will be using a GitHub project in this repo to share our work.

First, check out the What is a GitHub Project? page in this wiki to get an idea of what this feature offers us and how we can use it to elevate our communication as a team. This will be the tool we use today to track, share, and review the Markdown everyone makes.

Let's go there now and get familiar with how our project works before continuing...

What we will do today:

Now that you have a basic understanding of the concepts we will be learning about we are ready to get started! Make sure to check out (maybe leave this page up in another tab to reference while you work) the Overview page for a visual step-by-step breakdown of what to do when completing this course material. This will include the extra steps of how to put your work into the GitHub project to share your work, ask for help, and help others.

Note: Because we will be using a project, we will not make a new repository as shown in the beginning of the course description on the <>Code tab. To get started follow the Getting Started setup steps in the overview and jump right into following the instructions listed under Step 1. You will be following the overview when completing this as a group so do not be confused by following the instructions in the README under <>Code and ask questions (open issues) when you are unsure.

Now that we have covered the game plan for today go ahead and follow the Getting Started steps in the overview to begin!

Enjoy! :)