https://github.com/desktop/desktop-markdown-training

https://github.com/desktop/desktop-markdown-training

Last synced: 8 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/desktop/desktop-markdown-training
• Owner: desktop
• License: mit
• Created: 2022-11-14T21:09:58.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-11-26T07:19:12.000Z (over 3 years ago)
• Last Synced: 2024-12-31T03:27:35.915Z (over 1 year ago)
• Size: 5.65 MB
• Stars: 13
• Watchers: 2
• Forks: 19
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Markdown and GitHub made easy with GitHub Desktop and VS Code

Are you intimidated by using GitHub? Need to update markdown files in your team's repo and procrastinating? [GitHub Desktop](https://desktop.github.com/) can help! 

[GitHub Desktop](https://desktop.github.com/) simplifies git and GitHub and combined with VS Code can make you work life a little bit easier.

- [Markdown and GitHub made easy with GitHub Desktop and VS Code](#markdown-and-github-made-easy-with-github-desktop-and-vs-code)

  - [ℹ️ About this workshop](#ℹ️-about-this-workshop)

  - [💻 Prerequisites](#-prerequisites)

  - [📚 Overview](#-overview)

    - [:octocat: What is GitHub?](#octocat-what-is-github)

    - [🖊️ What is Markdown?](#️-what-is-markdown)

    - [:heart: GitHub + Markdown](#heart-github--markdown)

  - [:arrow_right: NEXT: Set Up](#arrow_right-next-set-up)

## ℹ️ About this workshop

This workshop was created by [@rmw](https://github.com/rmw) for GitHub's internal Day of Learning. It was created in response to hearing how non-engineers sometimes struggled with using GitHub.

## 💻 Prerequisites

The workshop assumes the following:

- you have a GitHub account. If not, you can [sign up here](https://github.com/signup).

- you are using a Mac. 

  - This workshop _should_ work with Windows just fine, but it has not been thoroughly tested.

## 📚 Overview

### :octocat: What is GitHub?

[GitHub](https://www.github.com) is the productive, collaborative, secure platform that developers love.

**GitHub revolutionaized software engineering.** It made finding, contributing and securing [open source](https://github.com/open-source) software much much easier. GitHub gave engineering teams [tools to get feedback](https://github.com/features/code-review), leading to higher quality and more secure code. It made [automation](https://github.com/features/actions) easier, requiring less resources to focus on things like CI/CD, creating releases and [packages](https://github.com/features/packages), and more. Today, GitHub is automating [security](https://github.com/features/security) and bringing the [power of AI](https://github.com/features/copilot) to development.

And it can be intimidating for non-software engineers.

 

**It takes a village to build, maintain, secure, deliver, market, and sell software.** This workshop aims to help demystify a common workflow for everyone else.



### 🖊️ What is Markdown?

Markdown is a lightweight markup language.

Language: text that a computer, with the right tools, knows how to turn into something else. In this case, it turns plain text into pretty text.

Markup: adding special characters (e.g. # or *) to text so that the computer knows how you want to display it. HTML is a also a markup language.

Lightweight: not trying to do it all.

**Why is it useful?**

- Not tied to a specific tool, such as Microsoft Word

- Simple to use

- Easy to read even with the special characters

- GitHub has its own flavor: [GitHub Flavored Markdown or GFM](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github)

### :heart: GitHub + Markdown

You can use Markdown in the following places on GitHub:

- [Issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues)

- [Pull Requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)

- Store markdown (`.md`) files in your repositories. ([Quickstart for writing on GitHub](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github))

- [Discussions](https://docs.github.com/en/discussions/quickstart)

- Comments

 ## :arrow_right: [NEXT: Set Up](1-set-up.md)

 Let's [get our computer ready](1-set-up.md) to start contributing to open source.