Product Formatter Guide ๐Ÿ“

Every Product begins with a little bit of magic at the top of the file, known as the "frontmatter". This is where you define all the metadata for your product using YAML.

Frontmatter (YAML Metadata)

At the beginning of your Markdown file, metadata is defined between two --- lines:

---
name: Pro UI Kit
slug: pro-ui-kit
kind: digital
category: Design Resources
status: published
visibility: public
price: 19.99
currency: USD
image: ./attachments/image.png
attachment: ./attachments/attachment.zip
pressUrl: https://sentilis.me/demo/press/sentilis-v2-launch
---

# Markdown Description...

Frontmatter Fields

FieldTypeRequiredDefaultDescription
namestringYes(inferred)Readable name of the product.
slugstringYes(inferred)Unique identifier.
kindenumNoserviceKind: service, product, digital.
categorystring | nullNonullCategory or collection.
statusenumNopublishedLifecycle: draft, published, archived.
visibilityenumNopublicAccess: public, private, protected, prime.
pricenumberNo0Price (>= 0).
currencystring | nullNonullISO Currency (USD, EUR...).
imagestring | nullNoauto-detectedCover image in attachments/.
attachmentstring | nullNoauto-detectedAttachment in attachments/.
pressUrlstring | nullNonullLink to an associated Press entry.
descriptionstring | nullNo(Markdown body)Short summary.

Valid Values

Status: draft, published, archived. Visibility: public, private, protected, prime.

Kind:

  • service: A service provided by the profile (consulting, mentoring, etc.). Default value.
  • product: A storable physical product.
  • digital: A downloadable digital product. Requires attachment โ€” the file the buyer receives.

Any other value will trigger a validation error.

Markdown Content

After the frontmatter comes the Markdown body, which is stored in the Product's description field. The following are automatically parsed:

  • Images (![alt](path)): Supported formats .png, .jpg, .jpeg, .gif, .svg, .webp.
  • Videos: Supported formats .mp4, .webm.
  • External Links: Must point to .html or non-multimedia resources; #... anchors are allowed.