APIMatic offers the flexibility to add custom guides and pages to your API Portal if you want to provide more contextual information about your API to your users.
The portal editor supports GitHub flavored Markdown. However, it does not currently support HTML tags.
The Markdown syntax for supported features is explained with examples:
Relative linking for referencing content in the portal has a little custom syntax:
When writing your documentation using Markdown, you can now define segments of your documentation to be language-specific.
Language-specific documentation only shows up when the API Portal user is viewing the documentation for that language. For example, if you mark a segment to be visible only for PHP, it will only show up in the PHP documentation in the API Portal; it will not be visible when any other language is selected.
In your Markdown page, use a
visible annotation to create a language-specific segment like this:
The valid language names are: