Export Wizard

The Export Wizard turns selected parts of your documentation into a DOCX, PDF, HTML or Markdown file. This page explains the settings, the formats and the export history.

Roles: Any signed-in user can export the services they can access. Every export is private to the user who started it. Exports need the export feature in your license and are counted against the monthly export quota of your tier. See License and Tiers.

Opening the wizard#

Choose Export Wizard in the top menu (/export-wizard). The page has an Export settings block and an Export history block.

Export settings#

  • Name of the export.
  • Services. Pick them in a tree dialog. Each service shows its structure: folders, tag groups, endpoints and text pages. A checkbox on a service, folder or tag selects everything below it. A checkbox on an endpoint or a text page selects only that item, and the folders around it stay checked while something below is selected. A service can be exported with text pages only.
  • Branch and version per service. The branch defaults to the service's main branch. A branch starts on the current version when it is on that branch, otherwise on its newest. Changing the version unselects endpoints the new version lacks and tells you how many.
  • Environment per service. With one selected, each endpoint gets a curl command built like the Try-It code tab.
  • Overlays switch per service. Overlay text is used only when on.
  • Changelog switch per service (off by default).
  • Format: DOCX, PDF, HTML or Markdown.
  • Language of the file's static texts. It defaults to the interface language. See Interface Translations.
  • Include table of contents (default on).
  • Pages at the start and Pages at the end. See Export Cover Pages.

What the file contains#

The file mirrors the selected tree: folders, tags, endpoints and text pages in the order the left menu shows. Each endpoint gets its description, request parameters and body, responses, errors, request/response examples and a curl command when an environment is selected. The file names the exported version under each service heading, for example "Version: 2.0.0 (2026-10-01)". GraphQL fields are documented with arguments and return type, without examples or curl.

Descriptions are rendered from Markdown: bold, italic, inline code, links, nested lists, quotes, code blocks and tables. Markdown headings inside descriptions become bold text. Images are replaced by their alt text, and nothing is fetched from the web, except pictures that belong to text pages, which are embedded.

With the table of contents on, every endpoint of a PDF, HTML or Markdown file starts with a "Back to contents" link.

Formats#

Format Notes
PDF Outline and clickable contents page. Bundled DejaVu fonts render Cyrillic and other Unicode text.
DOCX Heading 1–6 styles, so Word's navigation pane shows the tree.
HTML One self-contained page with embedded CSS, no JavaScript and no external resources. Works offline, follows the reader's light/dark setting, prints cleanly.
Markdown One GitHub Flavored Markdown file, readable as source and in viewers such as GitHub, GitLab and VS Code. Parameters, responses and errors are pipe tables.

Files record that they were generated by SelfDocHub with the application version and generation time, and nothing else: no user, service or environment names.

Change log in an export#

With Changelog on, the document gets a change log after the contents. It covers the versions of the chosen version's branch, from the oldest stored one up to the chosen one, newest first. Each version lists added, modified and removed endpoints and, for modified ones, parameters and response fields that were added or removed. It is unavailable when the chosen version has no older version to compare with. A log over 500 entries is cut after the newest versions, and this is reported in the finished export.

Export history#

Starting an export shows no message. The history opens if collapsed, scrolls to the new row and makes it blink three times (once, without animation, if reduced motion is set).

  • Each row shows progress, and offers download, repeat and delete. The history can be filtered by name, creation date range, status, format and language.
  • At most two exports generate at the same time.
  • If some endpoints cannot be exported, the export ends as error with the number actually exported, and its partial file is still downloadable.
  • An export still in progress when the application restarts is marked error.
  • Repeat reuses the saved settings. If the saved version no longer exists, the row says "Version not found - choose one manually" and Export stays disabled until you choose one.

Next steps#

Screenshots

Last updated: