Using GitHub

How GitHub can be used to store files or instructional content.

You can sync the following resources with GitHub:

  • Instructional content for the sidebar steps

  • Starting files for your content

The sync is currently uni-directional. In order to sync files from a GitHub repository, the GitHub account must allow access to Next Tech's GitHub OAuth application.

Allowing GitHub Access

As an admin or editor, navigate to your organization page and select the GitHub option:

Authorize GitHub Access

Select Allow GitHub Repository Access.

Next Tech will request access to your GitHub repo. Permission for third party access may be needed from within GitHub. Information about granting access can be found here.

Linking GitHub Repo to a Content

While in the creator, navigate to the Settings in the left navigation menu, and scroll down to GitHub Sync Settings.

Here you add two types of repositories:

  • A base repository will be used for both files and instructions.

  • A markdown repository will overwrite the base repository for instructions if provided.

If you have your files and instructions in the same repository, just set the base repository. If you have instructions in a separate directory, simply point the base repository to where your files are stored, and the markdown repository to where your instructions are stored.

Linking GitHub Instructions

To sync markdown files into the instruction pane, select + New Block and then the Markdown option. Make sure you select the option with the GitHub logo. This will display a text field for the full path, minus the values set in the GitHub Sync Settings:

To sync the instructions to GitHub, select the GitHub logo in the bottom right of the instruction pane:

Linking GitHub Files

GitHub file links specifies the path to the files that should be included in the content. Clicking the + New Link button will display two text fields, Remote Path and Local Path. The remote path contains the full path to directory in the repo that should be synced, excluding the account and root. The local path is the directory to sync the files to.

Be careful when copy and pasting GitHub paths, this can often introduce unintentional spaces and characters that will break the sync.

Once those variables have been set, you can sync your project to GitHub by clicking the Files drop down in the upper right corner of the screen and selecting Sync GitHub.

File options

The sync will produce one of two options:

Successful confirmation
Negative confirmation indicates a repository or path may be incorrect.

Once the files have synced successfully, be sure to save the files by clicking Save Files!