What is Publishing?

APIGit supports publishing an API Document from a specific SHA, which means taking that commit as a snapshot to build a versioned documentation site. This version of the document site includes:

• API Spec files in this snapshot
• Markdown documents in this snapshot

You can create multiple publishes, giving you multiple versions of API Documents, each pointing to a different SHA (snapshot).

Where to Publish

Publish from a Branch Head

Navigate to the API repository and switch to the branch you want to publish. Click the “Publish” button in the middle of the panel and select “Publish API Doc”:

Once you click the “Publish API Doc” button from the dropdown list, it will launch a dialog allowing you to publish the document from the head of the branch:

In the publish dialog, you can specify:

• Version of the document (like 1.0, 2.0)
• Description of this version
• Access permissions
• Whether to enable “Try it Out” functionality

Publish from a Specific Commit

Instead of publishing from the head of a branch, you can also navigate to the commits list and publish directly from a specific commit:

Publish while editing

In editing mode, you can also publish a document whitout exit editing mode by click “Publish” button and choose a commit to publish:

View Published Documents

View All API Document publishes of a Specific API Repository

Navigate to the API Repository’s publish center page to view all publishes of this API Repository:

View All API Document publishes Across All Repositories

To view all publishes across all repositories, click the global “Publish Center” button in the top navigation: