Basic Markdown Formatting for GitHub


This entry is part 2 of 4 in the series Markdown

Markdown uses simple symbols to format plain text.

You can write Markdown in Visual Studio Code, Notepad, or another text editor, then save the file with the .md extension.

Headings

Use number signs to create headings.

# Main Heading

## Second-Level Heading

### Third-Level Heading

The more number signs you use, the smaller the heading becomes.

Bold and Italic Text

Use two asterisks around text to make it bold:

**This text is bold**

Use one asterisk around text to make it italic:

*This text is italic*

You can also combine them:

***This text is bold and italic***

Bullet Lists

Use a hyphen followed by a space to create a bullet list:

- Python
- Flask
- SQLite
- Tailwind CSS

Numbered Lists

Use numbers followed by periods:

1. Pull the latest changes
2. Make and test updates
3. Commit the changes
4. Push to GitHub

Links

Markdown links use square brackets for the visible text and parentheses for the web address:

[Visit GitHub](https://github.com)

GitHub will display the words Visit GitHub as a clickable link.

Inline Code

Use single backticks around a short command, filename, or piece of code:

Run `git status` to see what changed.

The command will appear in a code style within the sentence.

Code Blocks

Use three backticks before and after a larger block of code:

```text
git pull
git status
git add .
git commit -m "Describe the change"
git push
```

You can replace text with a language name, such as python, html, or bash. GitHub may then add syntax highlighting.

Quotes

Use the greater-than symbol to create a quoted section:

> A README file acts as the front page of a GitHub repository.

Horizontal Lines

Use three hyphens on a line by themselves to create a horizontal line:

---

Task Lists

GitHub Markdown can also display checkboxes:

- [x] Create repository
- [x] Add README
- [ ] Add installation instructions
- [ ] Review documentation

An x marks a completed task, while an empty space marks an incomplete task.

A Complete README Example

# Social Enterprise Platform

A Flask-based platform for exploring social enterprise and social innovation.

## Technology

- Python
- Flask
- SQLite
- Tailwind CSS

## GitHub Workflow

1. Run `git pull`
2. Make and test changes
3. Run `git add .`
4. Commit the changes
5. Run `git push`

## Project Status

- [x] Private GitHub repository created
- [x] Initial project uploaded
- [ ] Clone project to second computer

## More Information

[Visit GitHub](https://github.com)

Markdown is useful because the source remains simple and readable, while GitHub displays it as formatted documentation.

Markdown

Markdown Files in GitHub Markdown for Jupyter Notebook

Leave a Reply