Blog API reference
Blog post content is stored and served as Markdown. Supported elements and rendering conventions.
Blog API — Markdown Support
Blog post content fields accept and return standard Markdown. The CrewPort blog renderer processes Markdown on the client side.
Supported elements
| Element | Markdown syntax |
|---|---|
| Headings | # H1, ## H2, ### H3 |
| Bold | bold |
| Italic | italic |
| Inline code | ` code ` |
| Code blocks | `language ... ` |
| Links | text |
| Images | !alt |
| Unordered lists | - item |
| Ordered lists | 1. item |
| Blockquotes | > quote |
| Horizontal rule | --- |
Content conventions
- Use
# Headingfor the post title within content — thetitlefield is the canonical title for metadata excerptshould be 1–2 sentences suitable for preview cards and SEO descriptions- Code blocks should include the language identifier for syntax highlighting (e.g.
go,json)
Related topics
- Blog API — Read — GET endpoints
- Blog API — Write — POST/PUT/DELETE endpoints