DEV Community

adamgonzo
adamgonzo

Posted on

Information on markdown for people just starting on Github!

GitHub is a powerful platform that allows developers to collaborate on code, track changes, and manage software projects. It can be a bit intimidating to get started, but once you understand the basics, it becomes a valuable tool in your development workflow. In this blog post, we'll cover the basics of using GitHub and how to use Markdown to create a nice design for your project.

First, let's talk about the basics of using GitHub. When you create a new repository, you'll be given the option to initialize it with a README file. This file is a great place to start when you're first setting up your project. It's where you'll provide an overview of what your project is, what it does, and how to use it.

Once you've created your repository, you'll be able to start making changes to your code. To do this, you'll need to clone the repository to your local machine. This will create a copy of the repository on your computer, which you can then work on. When you're ready to share your changes, you'll need to commit them to the repository. Committing your changes is like saving a snapshot of your code. It allows you to track the progress of your project and collaborate with others.

Now let's talk about Markdown. Markdown is a simple markup language that makes it easy to format text. It's often used to create README files and documentation for projects. Markdown is easy to learn, and it's a great way to add structure and organization to your text.

Here are some basic Markdown syntax examples:

1 - To create a heading, use one or more hash symbols before the text:


# Heading 1
## Heading 2
### Heading 3

Enter fullscreen mode Exit fullscreen mode

2 - To create a list, use a dash or a star before each item:


- Item 1
- Item 2
- Item 3

Enter fullscreen mode Exit fullscreen mode

3 - To create a link, use brackets for the text and parentheses for the URL:


[Google](https://www.google.com)

Enter fullscreen mode Exit fullscreen mode

4 - To add emphasis, use single or double asterisks or underscores:


*italic* or _italic_
**bold** or __bold__

Enter fullscreen mode Exit fullscreen mode

There are many more advanced features available in Markdown, but these are the basic syntax you need to know to get started.

In summary, GitHub is a powerful platform for managing software projects and collaborating with others. Markdown is a simple markup language that makes it easy to format text. By using these two tools together, you can create well-organized, easy-to-read documentation for your project that looks great.

Top comments (0)