Metadata Headers
Metadata Headers
Control per-file behavior using HTML comments at the top of your markdown files.
Format
<!-- Collection: Engineering -->
<!-- Title: Deployment Guide -->
<!-- Icon: 🚀 -->
<!-- Parent: Operations Runbooks -->
# Deployment Guide
Your content here...Supported Headers
| Header | Description | Example |
|---|---|---|
Collection | Target collection (overrides --collection-id) | <!-- Collection: Engineering --> |
Title | Explicit document title | <!-- Title: Getting Started --> |
Icon | Document icon in Outline UI | <!-- Icon: 🚀 --> |
Parent | Parent document for nesting | <!-- Parent: User Guide --> |
Title Resolution
The document title is determined in this order:
<!-- Title: ... -->header (if present)- First
# H1heading in the file - Filename without extension (e.g.,
deploy-guide.md→deploy-guide)
Collection Override
Each file can target a different collection, useful for mixed-content directories:
<!-- Collection: Operations -->
# Runbook: Database Failover
...<!-- Collection: Engineering -->
# Architecture Decision: Event Sourcing
...Parent Documents
Explicit parent assignment for nesting:
<!-- Parent: User Guide -->
<!-- Title: Installation -->
# Installation
...This creates Installation as a child of User Guide in the Outline tree.
The parent document must already exist (or be pushed in the same batch). See Directory Structure for automatic parent resolution.
Icons
Use emoji or Outline-supported icon names:
<!-- Icon: 🚀 -->
<!-- Icon: 📝 -->
<!-- Icon: ⚙️ -->