Meta tags:
description= Integrate GitHub with Document360 for seamless collaboration, syncing articles with code changes, and enhancing your team s documentation process.;
Headings (most frequently used words):
github, the, connect, document360, documentation, index, why, use, integration, before, you, begin, to, tutorial, best, practices, faq, extension, setting, up, your, git, repository, top, features, support, contact, us,
Text of the page (most frequently used words):
the (64), #github (47), document360 (44), your (25), repository (20), for (18), and (17), docs (17), article (14), you (14), are (12), articles (11), folder (11), documentation (10), extensions (10), this (10), branch (10), markdown (9), not (9), all (9), sync (9), must (9), integrations (8), knowledge (8), base (8), use (8), with (8), content (8), connect (8), from (8), integration (7), file (7), category (7), repositories (7), assets (7), zapier (6), categories (6), account (6), only (6), media (6), files (6), before (6), access (6), project (5), can (5), main (5), synced (5), structure (5), that (5), support (4), portal (4), then (4), connecting (4), each (4), connected (4), release (4), example (4), image (4), extension (4), select (4), open (4), page (4), 2026 (4), about (3), analytics (3), api (3), site (3), features (3), request (3), control (3), widgets (3), other (3), import (3), without (3), connection (3), uninstall (3), click (3), why (3), multiple (3), icon (3), will (3), available (3), commits (3), pull (3), published (3), source (3), structured (3), below (3), test (3), named (3), within (3), create (3), automatically (3), updated (3), appears (3), code (3), editor (3), product (3), review (3), ask (3), custom (3), policy (2), our (2), team (2), com (2), contact (2), feedback (2), drive (2), ticket (2), deflector (2), workflow (2), private (2), hosting (2), security (2), version (2), cases (2), integrating (2), using (2), export (2), management (2), next (2), via (2), yes (2), was (2), loop (2), because (2), find (2), separate (2), supports (2), during (2), alphabetical (2), order (2), syncs (2), newly (2), added (2), rather (2), than (2), alphabetically (2), revision (2), history (2), change (2), publish (2), supported (2), requests (2), what (2), referenced (2), names (2), navigate (2), notes (2), set (2), subfolders (2), one (2), correctly (2), png (2), upload (2), store (2), storage (2), name (2), remain (2), unchanged (2), where (2), follow (2), setting (2), git (2), pushed (2), publishes (2), need (2), redirected (2), back (2), new (2), into (2), install (2), want (2), grants (2), based (2), teams (2), contributions (2), step (2), community (2), mirrored (2), exactly (2), readers (2), manual (2), when (2), read (2), claude (2), chatgpt (2), view (2), copy (2), llms (2), ctrl (2), search (2), glossary (2), october (2), index (2), soc2, cookie, privacy, trust, center, terms, careers, culture, 3000, rating, status, seo, platform, assistant, top, enterprise, readiness, migration, demo, resources, pricing, customers, tags, google, slack, administration, zip, managing, types, related, zendesk, routing, submissions, salesforce, email, case, previous, helpful, clicking, sends, completing, likely, already, linked, another, resolve, application, attempt, again, app, settings, applications, installed, apps, once, uninstalled, return, reconnect, connector, stuck, infinite, repeating, steps, created, displayed, public, appear, currently, syncing, non, initial, imported, however, subsequent, incremental, any, appended, end, respective, being, reordered, happens, even, appearing, tracking, drafts, faq, auto, align, merge, schedule, windows, avoid, publishing, incomplete, coordinate, timing, protection, rules, gets, treat, truth, images, outside, render, keep, designated, since, maps, clear, make, easier, descriptive, least, configuring, empty, incorrectly, best, practices, watch, video, walkthrough, full, setup, tutorial, description, mediafilename, reference, following, syntax, inserting, format, subfolder, placed, inside, include, root, level, organize, point, whenever, commit, trigger, manually, creates, identified, confirmation, message, saying, has, been, successfully, initiated, type, enter, credentials, log, module, logged, login, screen, scope, grant, specific, requirements, tile, panel, opens, left, navigation, bar, under, section, connections, way, exporting, required, see, have, admin, begin, prefers, writing, local, natural, authoring, environment, first, projects, accept, ensures, approved, contributed, updates, tied, always, controlled, stay, releases, uses, hierarchy, different, versions, modules, giving, organized, navigable, entry, versioned, developers, own, write, same, merges, reflects, update, engineering, led, edits, made, creation, allowed, warning, lets, directly, pulls, them, imports, needed, prev, summary, plain, text, print, listen, focus, minute, nov, 2023, aug, powered, press, feature, self, service, troubleshooting, help, november, manage, integrate, manager, domain, customization, reminder, collaboration, tasks, interactive, decision, trees, fields, templates, variables, snippets, advanced, single, sign, role, workspaces, languages, key, creators, eddy, track, roles, permissions, invite, users, customize, quick, start, discover, pages, exploring, further, fetch, complete, https, txt,
Text of the page (random words):
github documentation index fetch the complete documentation index at https docs document360 com llms txt use this file to discover all available pages before exploring further quick start create an article review article publish article customize site invite users set up roles permissions track analytics eddy ai features for creators for readers for integrations key features multiple workspaces languages role based access control single sign on private hosting advanced editor templates variables snippets glossary drive file management custom fields interactive decision trees collaboration tasks custom workflow review reminder import export project site customization custom domain integrations extensions analytics feedback manager api documentation integrate with document360 manage your api docs release notes november 2026 12 11 1 october 2026 12 10 2 october 2026 12 10 1 help troubleshooting self service support ask for a feature community glossary search ctrl k press ctrl k to open search powered by github updated on aug 25 2026 published on nov 1 2023 5 minute s read focus listen print copy page copy as markdown for llms view as markdown view the page as plain text open in chatgpt ask chatgpt about this page open in claude ask claude about this page article summary prev next the github integration lets you sync markdown content from a github repository directly into your document360 knowledge base when commits are pushed to the connected repository document360 automatically pulls the updated files and publishes them no manual imports needed the folder and article structure in your github repository is mirrored exactly in document360 warning content synced from github is read only in document360 all edits must be made in the source github repository new article creation is not allowed within document360 for github synced categories why use the github integration engineering led documentation teams where developers own the docs 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 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 version controlled docs that stay in sync with releases your documentation updates are tied to code commits so docs and product are always in step with each other 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 markdown first teams if your team prefers writing in markdown in a local editor rather than the document360 editor github is the natural authoring environment before you begin you must have admin access to the document360 knowledge base portal you need a github account with access to the repository you want to connect your github repository must follow the required folder structure before connecting see setting up your git repository below the integration supports a one way sync github to document360 only exporting content from document360 back to github is not supported connect github to document360 connect the github extension in the document360 portal navigate to connections extensions in the left navigation bar you can find the github extension under the code repositories section click connect on the github extension tile the install panel opens select the repository scope you want to grant document360 access to all repositories grants access to sync all repositories in your github account only select repositories grants access to specific repositories based on your project requirements click install if you are not logged into github you are redirected to the github login screen enter your github credentials and log in you are redirected back to the document360 knowledge base portal the create new category module appears select github as the category type then select the repository from your connected github account a confirmation message saying your github has been successfully initiated appears document360 creates a category for the repository each branch in the repository appears as an article within that category identified by a branch icon from this point whenever a commit is pushed to the connected repository document360 automatically syncs and publishes the updated content you do not need to trigger the sync manually setting up your git repository your repository must be structured correctly before connecting it to document360 follow the structure below main folder the repository must include a root level folder named docs this is where you organize all subfolders and markdown articles this folder name must remain unchanged media files storage store all media files inside the docs document360 assets folder this folder name must remain unchanged for example if an image is referenced in an article named what is document360 the image file must be placed in docs document360 assets article storage within the docs folder create a subfolder to store your articles for example docs articles all articles must be in markdown md format inserting media files in articles to reference a media file in an article upload it to docs document360 assets and use the following syntax 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 watch the video below for a walkthrough of the full github integration setup 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 repository will not sync correctly use descriptive branch names since each branch maps to an article in document360 clear names for example v2 1 release notes make the knowledge base easier to navigate keep all 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 your release timing because commits auto publish align your github merge schedule with your documentation release windows to avoid publishing incomplete content faq are drafts or revision history available for github synced articles no revision history and change tracking are not available for github synced articles in document360 why are newly synced github articles not appearing in alphabetical order during the initial sync categories and articles are imported in alphabetical order however during subsequent incremental syncs any newly added categories or articles are appended to the end of the respective category rather than being reordered alphabetically this happens even if the content was added alphabetically in github can i sync a non main github branch with document360 no document360 currently supports syncing content only from the main branch of a connected github repository will the github icon appear on all categories no the github branch icon is displayed only for public categories can i connect multiple github repositories to document360 yes you can connect multiple repositories by repeating the connection steps each repository is created as a separate category in document360 why is the github connector stuck in an infinite loop and not connecting if clicking connect sends you to github in a loop without completing the connection it is likely because your github account is already linked to another document360 connection to resolve this uninstall the document360 application from your github account and then attempt to connect again to uninstall the document360 app from github go to your github account settings then applications then installed github apps find document360 and click uninstall once uninstalled return to document360 and reconnect was this article helpful yes no previous article routing ticket deflector submissions to salesforce via email to case next article zendesk related articles category types content management managing categories integrating github with document360 using zapier integrations extensions widgets other integrations extensions extensions zapier use cases of zapier import project zip file project administration security import export project slack integrations extensions widgets integrating google docs with document360 using zapier integrations extensions widgets other integrations extensions extensions zapier use cases of zapier tags version control markdown documentation github integration document360 customers pricing resources request a demo migration request security private hosting enterprise readiness top features knowledge base portal knowledge base site knowledge base assistant integrations and extensions platform api analytics workflow ticket deflector drive seo support documentation support status feedback contact us contact us support document360 com rating 4 7 3000 about us our team our culture careers terms trust center privacy policy cookie policy soc2
|
