API Portal
Portal pages
Create and publish content pages for your API Portal. Each page has a Content tab, a Settings tab, and a Partials (Beta) tab, plus visibility, table of contents, and full-width controls.
Pages are the content surface of your API Portal. You create them under Portal, Pages, write them in Markdoc with a live preview, set their visibility, and publish them. Apiable also uses pages for the landing page and product detail pages.
How do you create a portal page?
Go to Portal, Pages and choose + Add Page. Apiable creates a page titled New Page and opens its editor. Set the title, write the content, then turn the Published toggle on.
- Open Portal, Pages.
- Choose + Add Page. A page named New Page is created and its editor opens.
- Edit the title at the top. The slug is generated from the title.
- Write the page body on the Content tab.
- Turn the Published toggle on and choose Save Changes.
What are the tabs on the page editor?
The editor has three tabs: Content, Settings, and Partials (Beta). Content holds the body and preview. Settings holds the slug and visibility. Partials (Beta) holds reusable snippets.
| Tab | What it holds |
|---|---|
| Content | The Markdoc body, an insert toolbar, a live preview, and the Include table of contents toggle. |
| Settings | The Slug, the page URL, the Visibility toggle, and the Full Width toggle. |
| Partials (Beta) | Reusable content snippets you can rename, add, import, export, and remove. |
How do you write and preview content?
On the Content tab you write in Markdoc in the editor, and a live preview renders beside it as you type. An insert toolbar adds Markdoc tags. Turn on Include table of contents to add a contents list to the page.
To check how the page renders against a real API product, use the Preview using product selector below the editor. It is available on standalone pages and picks which product the preview uses for product-aware content.
How do you set a page's visibility?
Open the Settings tab and use the Visibility toggle. On makes the page public to unauthenticated visitors. Off hides the page content from visitors who are not signed in. Set the page address in the Slug field above it.
| Setting | Where | What it does |
|---|---|---|
| Slug | Settings | The page path after your portal URL. Apiable validates the format and that it is not already taken. |
| Visibility | Settings | On: public to everyone. Off: hidden from unauthenticated visitors. |
| Full Width | Settings | On: content spans the full width. Off: content sits in the default column. |
| Published | Top of editor and pages list | On: the page is live on the portal. Off: the page is not served. |
How do you publish or unpublish a page?
Use the Published toggle. It sits at the top of the page editor and in the Status column of the pages list. On serves the page on the live portal. Off keeps it as a draft. Choose Save Changes in the editor to save.
A page must be Published to appear on the portal. Visibility then decides whether unauthenticated visitors can see it. You can filter the pages list to PUBLISHED to see only live pages.
Why can you not edit some page settings?
The page is protected. Protected pages, such as the landing page and product detail pages, lock the Settings tab and show a notice that settings cannot be edited. You can still edit their content on the Content tab.
How do you delete a page?
In the pages list, open the row menu and choose Delete, then confirm. Apiable checks whether the page is referenced elsewhere first. Pages that are referenced, and protected pages, cannot be deleted.
Troubleshooting
| What you see | What to do |
|---|---|
| The slug field shows a format error | The slug contains characters that are not allowed in a path. Use lowercase letters, numbers, and dashes. |
| The slug field says it is taken | Another page already uses that slug. Choose a different one. |
| The page does not appear on the portal | Confirm the Published toggle is on. Then check Visibility if unauthenticated visitors cannot see it. |
| The Settings tab is locked | The page is protected. Edit its content on the Content tab; settings stay fixed. |
| Delete is disabled | The page is referenced elsewhere or is protected. Remove the references first, or it cannot be deleted. |
Where to next
Navigation
Add your published pages to the header and footer menus and set their order.
Theme
Set the colors and typography that your pages render with.
SEO and marketing
Set the portal title, meta tags, and social preview for your pages.
Customization
Go further with reusable partials and Markdoc components across pages.