Articles and collections

Articles are blog or news style posts you publish on your API Portal. You write them under Content, Articles, and you group them into named collections under Content, Collections. The body is written in a rich-text editor, unlike portal pages and documentation hubs, which use Markdoc.

How do you add an article?

Choose + Add Article. Apiable creates the article straight away, named New Article, published and visible to everyone, and opens its editor. Write it, then choose Save Changes.

1. Open Content, Articles and choose + Add Article.
2. The editor opens with the title ready to edit. Type the title. The slug follows the title as you type.
3. If the article is not ready to go live, switch Published to Unpublished and choose Save Changes now.
4. Write the body, and fill in the Description, Tags and Featured image if you want them.
5. Choose Save Changes. When the article is ready, switch it to Published and save again.

A new article is live from the moment it is created, at /content/ followed by its ID, until you save a new slug or unpublish it. It also appears in any articles collection component that lists every article.

What is in the article editor?

A title, a description, a slug, tags, a featured image, and a rich-text body, plus two toggles and Save Changes. With Collections on your plan, a link under the title adds the article to a collection.

If you leave the editor with unsaved changes, a dialog asks Do you want to save?

How do you set who can see an article?

With the visibility toggle in the editor. Visible to everyone lets any visitor read the article. Logged in users only shows it only to signed-in users, and visitors who are not signed in get a not-found page. Choose Save Changes after you switch it.

Published decides whether the article's page is live at all. Visibility then decides who can read a published article.

How do you create a collection and add articles to it?

Create the collection under Content, Collections, then add each article to it from the article editor. The collection's name becomes part of the article's address.

1. Open Content, Collections and choose Add another collection.
2. In Create a New Collection, enter the Collection Name and choose Save Changes.
3. Open an article under Content, Articles and choose Add to an collection under its title.
4. In Add article to a Collection, pick the collection under Collection and choose Confirm.
5. Choose Save Changes on the article.

The Add to an collection link appears only when Collections are on your plan. Without Collections, you can still publish articles on their own.

How do you list articles on your portal?

Add the articles collection component to a portal page. Your portal has no automatic list of articles or collections, so this component is how readers find them. Give it a collection name, or leave the name out to list every published article.

The component is the self-closing articlesCollection Markdoc tag. For example, the tag with collection="Release notes" and view="card" shows the articles of the Release notes collection as cards.

Visitors who are not signed in see only articles set to Visible to everyone. For where pages are edited and the other components, see Portal pages and Markdoc components.

Where do articles appear on the portal?

Under /content on your portal. An article with no collection is at /content/article-slug. An article in a collection is at /content/collection-name/article-slug, with the collection's name as it is written, and the article page shows the collection's name above the title.

The line under Slug in the editor shows the full address. Because the collection's name appears in the address and in the component, renaming a collection changes article addresses. After you rename one, update any articles collection component that lists it by its old name.

How do you rename or delete a collection?

In Content, Collections, open the collection's row menu. Choose Edit to rename it inline, then Update. Choose Delete, then confirm, to remove it. Deleting a collection removes it from its articles and does not delete them.

How do you delete an article?

In the Articles list, open the article's row menu and choose Delete, then confirm in Delete Article. If something else on your portal uses the article, the confirm button is disabled and the dialog explains why.

Troubleshooting

Where to next