Exporting HTML to a GitHub Repository
Step-by-Step Guide
1
Open the Export Menu
- Start by clicking the Export button in the TileDocs Editor.
- From the dropdown, select Export to HTML and Upload to GitHub.

Export Menu
2
Specify the Website's Root Address
- In the dialog that appears, you’ll need to specify the root address where the documentation website will be hosted. This could be your domain or a nested route if you plan to host it under a subdirectory (e.g.,
example.com/docs/
).

Specify the Website's Root Address
3
Set Up GitHub Connection
- If you haven’t yet installed the TileDocs GitHub App, click the Set Up GitHub Connection button. This will guide you through installing the app and granting it access to your repositories.
- Read more about GitHub connection in TileDocs GitHub App Installation.
- Once installed, select a repository from the list of allowed repositories.
- Important: Avoid using the same repository where your TileDocs projects are stored to prevent conflicts.

Set Up GitHub Connection
4
Select the Branch and Directory
Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
- Choose the branch of the repository where the HTML bundle will be uploaded.
- If the repository already contains files, it’s recommended to use a separate directory within the repository for the export. This ensures that only the content within this directory will be replaced by the newly generated HTML, leaving other files untouched.

Select the Branch and Directory
5
Export and Upload
- After filling in all the required details, hit the Export button.
- TileDocs will then generate the HTML bundle and push the files directly to the selected repository and branch.
Things to Keep in Mind
- Separate Directories: If your repository is already in use, always use a separate directory for exporting the HTML. This will avoid overwriting other important files in the repository.
- Avoiding Conflicts: Do not select the same repository that you use to store TileDocs project files, as this could cause data conflicts.
By following these steps, you can easily host your documentation website on GitHub or any other platform that supports static HTML hosting from a GitHub repository.