confluence-api-doc

You can sync Markdown API documentation to Confluence pages by parsing Markdown files and splitting content by H2 and H3 headings to create a hierarchical page structure using acli and the Confluence REST API.

Confluence API documentation sync handles hierarchical page structures by splitting Markdown content at H2 and H3 headings, mirroring API domains and endpoints into a parent-child page structure within your Confluence space.

Yes, you need acli for authentication and curl for API interactions to automate the process of syncing Markdown documentation to Confluence pages via the Confluence REST API.

Yes, syncing Markdown API docs to Confluence handles both creation and updates of pages, ensuring your API documentation remains up-to-date by automatically modifying existing corresponding pages when the source Markdown file changes.

The best way to maintain a single source of truth for API documentation in Confluence is to automate syncing from Markdown files, which creates and updates hierarchical pages based on H2 and H3 headings to keep everything organized and current.

Syncing Markdown files to Confluence using acli depends on parsing H2 and H3 headings for page structure, meaning content not organized under these headings may not map correctly to the hierarchical parent-child page structure in Confluence.