Skip to content

Latest commit

 

History

History
108 lines (68 loc) · 3.71 KB

Help.md

File metadata and controls

108 lines (68 loc) · 3.71 KB

Instructors GitHub Help

You will need a GitHub account and permissions to access this repository before you can continue.

Talk to an active contributor to get given permissions.

This page contains information on how to add or update content within the Engage repository.

Content Warning

Keep these points in mind as you add content to this repository:

  • This is public. Do not add sensitive, private, or inappropriate content.
  • GitHub keeps a history of all changes. Do not add large files or images.

Page Content Format

GitHub uses Markdown for authoring content. After updating a page with Markdown the page is rendered via GitHub to an easily readable format.

See Mastering Markdown for further details.

Quick Reference:


# This is an <h1> header tag
## This is an <h2> header tag

_This will be italic_
__This will be bold__

* Unordered list item
  * Unordered sublist item

1. Ordered list first item
1. Ordered list second item (the 1. is not a typo)
   1. Ordered list sublist item

[Hyperlink Text](http://hyperlink.target)

![Embedded image hover text](http://link.to.image.png)

[![Clickable image](http://image.png)](http://link.target)

> Quote

Inline code with a single `back tick`.

Block code with three back ticks to open the block and three to close the block.

Edit Page Content

  1. Ensure you are looking at a file in the repository and not a directory.
  2. Click the Edit this file button that looks like a pen 🖊️.
  3. Add or change the content using Markdown format.
  4. Click the green Commit changes button at the bottom of the browser window.

Create New Page

  1. Go to the parent directory within the repository.
  2. Click the Create new file button.
  3. Type the page name with the extension .md eg: notes.md.
  4. Click in the content section and add content using Markdown format.
  5. Click Commit new file at the bottom of the browser window.

Create New Directory

  1. Go to the parent directory.
  2. Click the Create new file button.
  3. Type in the directory name.
  4. Type a forward slash /.
  5. Type README.md.
  6. Click in the new README page and add content using Markdown format.
  7. Click Commit new file at the bottom of the browser window.

Delete Page

  1. Ensure you have selected the page and not a directory.
  2. Click the Delete this file button that looks like a little bin 🗑️.
  3. Click Commit changes at the bottom of the browser window.

Delete Directory

To delete a directory delete all the files contained within the directory. Directories don't technically exist within Git, only file paths.

Alternatively use Git to clone the repository and work with it locally.

Octotree

This is not required however the browser extension called Octotree will make it easy for you to navigate the contents of any repository on GitHub.

Click one of the links below to add to your browser: