Connecting ArkScribe to GitHub

Connecting your ArkScribe projects to a GitHub repository allows you to save and load your work, collaborate with others, and publish your guides to the web using GitHub Pages.

Prerequisites

Before you start, you will need:

• A GitHub account. If you don't have one, you can create one for free.
• A GitHub repository to store your project. You can create a new repository here.

Step 1: Get a GitHub Personal Access Token

To allow ArkScribe to access your repository, you need to create a Personal Access Token.

1. Go to your GitHub Developer settings to generate a new token.
2. Give your token a descriptive name, for example, "ArkScribe".
3. Set an expiration date for your token.
4. Under "Repository access", select "Only select repositories" and choose the repository you created for your ArkScribe project.
5. Under "Permissions", click on "Repository permissions".
6. Find "Contents" and change its access level to "Read and write".
7. Click "Generate token".
8. Important: Copy the generated token immediately. You won't be able to see it again.

Step 2: Connect ArkScribe to Your Repository

Now, let's connect ArkScribe to your GitHub repository.

1. In the ArkScribe editor, find and click on the GitHub button in the top toolbar.
2. In the GitHub integration panel, paste the Personal Access Token you copied.
3. Enter your repository name in the format owner/repository-name (e.g., my-username/my-awesome-guide).
4. Click Save.

Step 3: Save, Load, and Collaborate

Once connected, you can:

• Save: Save your current project directly to the connected GitHub repository.
• Load: Load a project from the repository to continue editing.
• Collaborate: Invite others to your GitHub repository to work on the project together.

Step 4: Publish with GitHub Pages

You can publish your guide as a live website using GitHub Pages.

1. Export your guide: Use the export function in ArkScribe to prepare your guide for publishing. This will typically generate the necessary files (HTML, CSS, etc.).
2. Enable GitHub Pages:
   • Go to your repository on GitHub.
   • Click on the Settings tab.
   • In the left sidebar, click on Pages.
   • Under "Build and deployment", for the "Source", select "Deploy from a branch".
   • Choose the branch where your exported guide is located (e.g., main).
   • GitHub will create a public URL for your guide. It might take a few minutes for your site to be published.

You can now share the link to your published guide!