My Awesome Vendor - Getting Started

A step-by-step guide to authoring and publishing a vendor page on the platform.

Prerequisites

Before creating a vendor page you need:

  • An author or admin account on the platform
  • A handle for your vendor — a short, URL-safe slug (e.g. my-product)
  • At least one cover image (cover.png, 1200 × 630 px recommended)

File Structure

A vendor page is a directory with this layout:

/<vendor-slug>/
├── __static__/
│   └── cover.png          # card image
├── index.md               # required — vendor metadata + landing page body
├── getting-started.md     # optional sub-page
└── any-other-page.md      # optional sub-page

The index.md file is the only required file. Every other .md file becomes a sub-page automatically.

Writing index.md

Start with the frontmatter block:

---
kind: page

title: "My Product"
description: "One sentence that captures what this product does."

categories:
  - observability        # or another taxonomy slug

tagz:
  - tag-one
  - tag-two

createdAt: 2025-01-01
updatedAt: 2025-06-01

cover: /content/files/vendors/uncloud/__static__/cover.png?v=1780174437278

style: |
  h1, h2, h3 { color: #0f4c81; }
  a:not([class]) { color: #1d6aa5; font-weight: 500; }

tutorials:
  my-tutorial-slug: {}
courses:
  my-course-slug: {}
---

The tutorials and courses maps declare which associated content pieces can be embedded in this page. The keys in the map must match the slugs of existing tutorials or courses on the platform.

Linking to Sub-Pages

Inside any body text, link to other pages in your vendor hub using the vendor slug:

[Getting Started →](/v/my-product/getting-started)
[API Reference →](/v/my-product/api-reference)

If you're editing the sample vendor, use uncloud as a placeholder for the actual slug so the content stays portable:

[Getting Started →](/v/uncloud/getting-started)