Welcome to your repository!
This repository is all about communicating on GitHub. The first thing to know about communicating on GitHub is that Markdown is an easy and widely used way to format your text.
Later, we'll get into some other things, like Project boards, important documents like ISSUE_TEMPLATE
s, crosslinking between issues, and more!
What is markdown?
Markdown is a lightweight and easy-to-use syntax for styling all forms of writing on the GitHub platform.
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 *
. You can use markdown with the toolbar in issues and pull requests, or you can learn the simple syntax and type it yourself.
You can use Markdown most places around GitHub:
- Gists
- Comments in Issues and Pull Requests (like this one!)
- Files with the
.md
or .markdown
extension
For more information, see “Writing on GitHub” in the GitHub Help.
Let's get started!
A Few Examples
Emoji
Emoji are fun ✨, and they can be silly 😜, but they can also be an important communication tool when working with remote teams ✅. Tone doesn't come across as clearly when reading text as it comes speaking face to face, and emojis can be helpful in conveying context and emotions. ❤️
Here are some examples of popular emojis in markdown.
What you see |
What you type |
❤️ |
:heart: |
👍 |
:+1: |
😄 |
:smile: |
✨ |
:sparkles: |
🎉 |
:tada: |
If you aren't sure what emojis are possible, you can look them up on a cheatsheet. In many places on GitHub, you can type :
and then begin to type the name of an emoji. A fuzzy search will bring up the 5 best guesses and let you select one.
Header
An example of a header is, well, the header at the beginning of this issue! Just like in any text editing software, a header is a larger bit of text at the beginning of a section.
# This is an <h1> tag
## This is an <h2> tag
###### This is an <h6> tag
The fewer the #
, the larger the header.
Emphasis
You can also use **bold** and _italic_ text in markdown. In markdown, sometimes there are multiple ways to accomplish the same goal.
*This text will be italic*
_This will also be italic_
**This text will be bold**
__This will also be bold__
_You **can** combine them_
Links
Creating links is important when communicating in issues and pull requests.
Sometimes, you may want to link to a website, a repository, or even a line of code. But long URLS are not easy on the eyes. To create a link, put the text you want to display in the square brackets, and the URL in the following parenthesis.
[GitHub](http://github.com)
First Assignment
- Leave a comment to this issue. Use markdown. Include all of the following:
- At least 1 emoji
- Any type of header
- Bold or italics
- A link to your GitHub profile (like
http://github.com/USERNAME
)
Good luck!