GitWiki Tutorial - erynmcfarlane/StatsGenLabProtocols GitHub Wiki

Introduction

GitHub Wikis are repositories within repositories that allow you to create and share detailed documentation for your project. For the Stats Gen Lab, we will use one Repository just for all of our protocols, tutorials, etc, to keep everything in once place. This also makes is possible for folks to download everything at one time.

Step 1: Accessing the Wiki

  1. Navigate to your https://github.com/erynmcfarlane/StatsGenLabProtocols
  2. Look for the Wiki tab in the repository's menu. Click on it.

Step 2: Creating a New Page

  1. In the Wiki tab, you'll find an interface to create new pages.
  2. Look for the New page button and click on it.
  3. Enter a title for your new page in the Page title input box. This should be the title of your protocol or tutorial
  4. Start writing content for your new page in the editor.
  5. You can use Markdown syntax to format your content (e.g., headings, lists, code blocks, etc.).
  6. Once you're done, click Save Page to save your new page.

Step 3: Editing an Existing Page

  1. To edit an existing page, navigate to it in the Wiki.
  2. Click the Edit button at the top-right corner of the page.
  3. Make your changes using the Markdown editor.
  4. Once you are satisfied with your changes, click Save Page.

Step 4: Formatting Your Content

You can use Markdown syntax to format your content in the Wiki. Here are some common Markdown formatting options:

  • Headings: Use # to create headings. For example:

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

  • Lists:

    • Unordered list: Use *, +, or - followed by a space for each item.
      • Example:
        • * Item 1
        • * Item 2
    • Ordered list: Use numbers followed by a period (1., 2., etc.).
      • Example:
        • 1. Item 1
        • 2. Item 2

  • Links: Create links using [link text](URL).

    • Example: [GitHub](https://github.com) GitHub

  • Code blocks:

    • Inline code: Use backticks `code`.
    • Code block: Use triple backticks to create a code block with language syntax highlighting. 
      ```python
print("It's probably drift!")

Step 5: Adding Images to a page

Here's a page describing how to add images to github wikis - I have already made an 'images' folder for us in this repository.

How to add images

Step 6: Creating Links Between Pages

You can link one Wiki page to another using a special syntax. Wrap the page title in square brackets.

  • Example: [Page Title]

This will create a hyperlink that points to another page in your Wiki.

Step 7: Viewing Page History

  1. Navigate to a page in the Wiki.
  2. Click the History button at the top-right corner of the page.
  3. You will see a list of all the changes made to the page, including who made the changes and when.