GitHub

The GitHub integration lets you sync content from a GitHub repository directly into your Document360 knowledge base. When you commit changes to a connected branch, Document360 automatically pulls the updated Markdown files and publishes them — no manual imports needed.

Configuring GitHub in Document360

To configure GitHub in Document360,

1. Navigate to  Connections () > Extensions in the left navigation bar in the Knowledge base portal.

   You can find the GitHub extension under the Code repositories section.

2. Click Connect on the extension tile.

   

   A new Install panel will open.

3. Select one of the two options based on your requirements:

   • All repositories - choose to sync all repositories.

   • Only select repositories - choose to sync specific ones based on your project requirements.

4. Click Install.

If you are not logged into GitHub, you will be redirected to the login screen.

6. Enter your GitHub credentials and log in. You will be redirected to the Document360 Knowledge base portal. The Create new category module will appear.

7. Select GitHub () as the category type. Select the repository from your configured GitHub.

A confirmation dialog saying ‘Your GitHub has been successfully initiated’ will appear.

Once connected, Document360 creates a category for the repository. Each branch appears as an article within that category, identified by a branch icon. Whenever a commit is pushed to the connected repository, the content is automatically synced and published.

8. The repository category, along with all the branches, is created as articles in Document360. Each time a GitHub user updates the repository, the content is synced with the mapped Document360 articles.

   You can identify each entity in Document360 in the GitHub category by a branch () icon.

    

   ---

   Setting up a Git repository

   To configure a Git repository for content access in Document360,

   Ensure that your Git repository is appropriately set up and configured to enable fetching the content into the Document360 project. Follow the structure below:

          Main folder:

   • In GitHub, the repository must include a main folder named docs where you can organize subfolders and Markdown articles.

   • This folder name must remain unchanged.

     Media files storage:

   • Store all media files inside the .document360/assets folder within the docs directory.

   • This folder name must remain unchanged.

     For example, if an image is referenced in a file named 'What is Document360', it should be moved to the .document360/assets folder.
     Article storage:

   • Within the docs folder, create a separate directory, for example, articles to store your articles.

   • Articles must be in Markdown (.md) format.

     Inserting media files in articles:

   • Upload the media file to the .document360/assets folder.

   • Use the following syntax to insert the media file into your article:

     ![image description](/docs/.document360/assets/mediafilename.extension)

   • For example, if your media file is named test.png, use:

     ![test image](/docs/.document360/assets/test.png)

Tutorial

Best practices

• Structure your repository before connecting. Set up the docs folder, subfolders, and at least one .md file before configuring the integration. An empty or incorrectly structured repo will not sync correctly.

• Use descriptive branch names. Since each branch maps to an article in Document360, clear naming (for example, v2.1-release-notes) makes the knowledge base easier to navigate.

• Keep media files in the designated assets folder. Images referenced outside docs/.document360/assets will not render in Document360.

• Treat the main branch as your source of truth. Only the main branch is supported for sync. Use pull requests and branch protection rules in GitHub to control what gets published.

• Coordinate release timing. Because commits auto-publish, align your GitHub merge schedule with your documentation release windows to avoid publishing incomplete content.

Use cases

Engineering-led documentation Teams where developers own the documentation can write and review Markdown files in the same pull request as the code change. When the PR merges, Document360 automatically reflects the update.

Versioned product documentation If your docs repository uses a structured folder hierarchy for different product versions or modules, that structure is mirrored exactly in Document360, giving readers an organized, navigable knowledge base without manual re-entry.

Open-source or community-contributed docs For projects that accept documentation contributions via GitHub pull requests, the integration ensures that approved contributions are published to Document360 without a separate upload step.