Doxxy

Doxxy is a GitHub Action for publishing documentation. Keep markdown in your repo, review changes in pull requests, and Doxxy publishes to Confluence, SharePoint, Zendesk, ServiceNow, Notion, and Google Drive on every push.

It runs inside your GitHub runner. Your docs and destination credentials never pass through Doxxy servers; the servers are only contacted for license validation. See the Security Model.

This documentation is itself published by Doxxy, from the repo's /docs folder.

Start here

New to Doxxy? Sync a markdown folder to Confluence in about ten minutes:

  1. Create a Confluence API token
  2. Add a doxxy.toml config file
  3. Add the GitHub Actions workflow
  4. Push, and verify the generated pages

Follow the Confluence quickstart. Other platforms each have their own setup guide.

Learn the model

Reference