Slides | Shawn McCarthy

GitHub Introduction

Mon, 22 May 2023 00:00:00 +0000

Introduction to GitHub

GitHub | Documentation

What is GitHub?

A platform for version control and collaboration
It allows you and others to work on projects from anywhere

Setting Up GitHub

Go to GitHub.com
Click on Sign Up
Fill in your details and click Create account

Creating a New Repository

After logging in, click on New repository
Name your repository
Choose to make the repository Public or Private
Make sure the default branch name is main
Click Create repository

Cloning a Repository

Navigate to the main page of the repository
Click Code
To clone the repository using HTTPS, under “Clone with HTTPS”, click the clipboard icon
Open Git Bash
Change the current working directory to the location where you want the cloned directory
Type git clone, and then paste the URL you copied earlier
Press Enter to create your local clone

Making Changes

Navigate to the file in your repository that you want to change
Click the pencil icon in the upper right corner of the file view to edit
Make and commit your changes

Creating a .gitignore File

In your repository, create a new file named .gitignore
For a Node.js project, you might include the following in your .gitignore:

node_modules/
npm-debug.log
.DS_Store
.env

About .env and .gitignore

.env files usually contain sensitive information like API keys and should not be tracked in Git
Including .env in your .gitignore ensures it won’t be committed to your GitHub repository
Instead, provide a .env.example file with the required keys and dummy values to guide others

Pushing Changes

Open a terminal
Navigate to your repository directory
Type git add . to add all changes
Type git commit -m "Your message" to commit changes
Type git push to push changes to GitHub

Pulling Changes

Open a terminal
Navigate to your repository directory
Type git pull to update your local repository with the latest changes

Issues

Issues are a great way to keep track of tasks, enhancements, and bugs for your projects

Navigate to the main page of the repository
Click Issues
Click New issue
Create a title and write a description for your issue
Click Submit new issue

Pull Requests

Pull requests let you tell others about changes you’ve pushed to a branch in a repository on GitHub

Navigate to the main page of the repository
Click Pull requests
Click New pull request
Select the branch you made changes to and the branch you want to merge changes

into 5. Review your changes and click Create pull request

Questions?

Ask Documentation

Slides

Tue, 05 Feb 2019 00:00:00 +0000

Create slides in Markdown with Wowchemy

Wowchemy | Documentation

Features

Efficiently write slides in Markdown
3-in-1: Create, Present, and Publish your slides
Supports speaker notes
Mobile friendly slides

Controls

Next: Right Arrow or Space
Previous: Left Arrow
Start: Home
Finish: End
Overview: Esc
Speaker notes: S
Fullscreen: F
Zoom: Alt + Click
PDF Export

Code Highlighting

Inline code: variable

Code block:

porridge = "blueberry"
if porridge == "blueberry":
 print("Eating...")

Math

In-line math: $x + y = z$

Block math:

$$ f\left( x \right) = ;\frac{{2\left( {x + 4} \right)\left( {x - 4} \right)}}{{\left( {x + 4} \right)\left( {x + 1} \right)}} $$

Fragments

Make content appear incrementally

{{% fragment %}} One {{% /fragment %}}
{{% fragment %}} **Two** {{% /fragment %}}
{{% fragment %}} Three {{% /fragment %}}

Press Space to play!

One Two Three

A fragment can accept two optional parameters:

class: use a custom style (requires definition in custom CSS)
weight: sets the order in which a fragment appears

Speaker Notes

Add speaker notes to your presentation

{{% speaker_note %}}

- Only the speaker can read these notes
- Press `S` key to view
 {{% /speaker_note %}}

Press the S key to view the speaker notes!

Themes

black: Black background, white text, blue links (default)
white: White background, black text, blue links
league: Gray background, white text, blue links
beige: Beige background, dark text, brown links
sky: Blue background, thin dark text, blue links

night: Black background, thick white text, orange links
serif: Cappuccino background, gray text, brown links
simple: White background, black text, blue links
solarized: Cream-colored background, dark green text, blue links

Custom Slide

Customize the slide style and background

{{< slide background-image="/media/boards.jpg" >}}
{{< slide background-color="#0000FF" >}}
{{< slide class="my-style" >}}

Custom CSS Example

Let’s make headers navy colored.

Create assets/css/reveal_custom.css with:

.reveal section h1,
.reveal section h2,
.reveal section h3 {
 color: navy;
}

Questions?

Ask

Documentation