GitHub App Installation

TileDocs integrates with GitHub using its own GitHub App to allow you to securely manage your documentation projects.

Only Read and Write Permissions


The TileDocs GitHub App requires only read and write permissions on your selected repository - no administrative permissions are needed.


You can control exactly which repositories the TileDocs app can access, ensuring a secure and personalized connection.

Connect Your Project to GitHub

By default, all new projects in TileDocs are stored locally in your browser’s database. However, you can easily upload any project to a GitHub repository for cloud storage and version control.

1

Create a GitHub Repository

Before starting the upload process, you’ll need to create an empty repository in your GitHub account. This repository will store your project data. Make sure it is completely empty to avoid conflicts during the upload.

2

Connect TileDocs to GitHub

1

Save Project

In TileDocs, open the project you want to upload and click the Save Project on GitHub button.

Save project on GitHub button

Save project on GitHub button

2

Setup Connection

A dialog will appear. Click the Set Up GitHub Connection button

Set up GitHub connection button

Set up GitHub connection button

3

Install App

You will then be prompted to choose the GitHub account where you want to install the TileDocs GitHub App. Once selected, you can choose which repositories the app will have access to.

4

Select Created Repo

After selecting the account and installing the app, choose your newly created repository from the list in the dialog dropdown.

Select repository

Select repository

5

Save Project

Once selected, click the Save button to push all your project data to GitHub.

Syncing and Accessing Your Project

After the initial upload, TileDocs allows you to seamlessly sync future changes with the repository. Each time you save your project, your changes will be pushed directly to GitHub, ensuring that your work is always backed up.

Additionally, if you switch to another web browser or device, you can easily download your project from GitHub. This way, you won’t lose any progress, even if your local browser data is cleared.

By connecting to GitHub, TileDocs provides an efficient way to manage, back up, and collaborate on your documentation projects, all while keeping your data secure and easily accessible across devices.

Search