How to Change Output Format
aprity supports multiple documentation formats. This guide explains how to select the formats you need before running a scan.
Available Formats
| Format | Description |
|---|---|
| Markdown | Plain text Markdown files |
| HTML | Single-page HTML with collapsible sections |
| DOCX | Microsoft Word document |
| Portable Document Format | |
| Knowledge | Salesforce Knowledge articles |
| Confluence | Atlassian Confluence pages |
Steps
- Open the aprity app in Salesforce.
- Navigate to the Generate tab.
- In the output format section, you will see tiles for each available format.
- Click on a tile to select it (highlighted) or click again to deselect it.
- Select one or more formats for your scan.
- Configure other scan options as needed, then click Generate.
warning
Changing the output format does not retroactively update previous scans. You must run a new scan to generate documentation in a different format.
Format Availability by Plan
Not all formats are available on every plan:
| Plan | Available Formats |
|---|---|
| Trial | Markdown, HTML |
| Starter | Markdown, HTML |
| Professional | Markdown, HTML, DOCX, PDF |
| Enterprise | All formats including Knowledge, Confluence, custom DOCX templates |
info
If a format tile appears grayed out, your current plan does not include it. See How to Upgrade Your Plan for more information.
Tips
- You can select multiple formats in a single scan. aprity generates all selected formats in one pass.
- PDF and DOCX formats include branded headers and footers automatically.
- Confluence format requires a connected Confluence instance. See How to Connect Confluence.