scribe.yaml Reference

File location

Framework	Location
Hugo	data/scribe.yaml
Astro	src/data/scribe.yaml

scribe searches both locations automatically.

Complete example — Hugo

framework: hugo

categories:
  - news
  - review
  - guide
  - tutorial

authors:
  - tor
  - ola

edit_zones:
  - path: content/posts
    label: Blog posts
    type: markdown
  - path: content/pages
    label: Pages
    type: markdown
  - path: data
    label: Data files
    type: data

shortcodes:
  - name: youtube
    label: YouTube Video
    icon: player-play
    fields:
      - { name: id, label: Video ID, type: string }
  - name: figure
    label: Image with caption
    icon: photo
    fields:
      - { name: src, label: Image URL, type: string }
      - { name: alt, label: Alt text, type: string }
      - { name: caption, label: Caption, type: string }

Complete example — Astro

framework: astro

categories:
  - news
  - review
  - guide

authors:
  - tor

edit_zones:
  - path: src/content/posts
    label: Blog posts
    type: markdown
  - path: src/content/pages
    label: Pages
    type: markdown
  - path: src/data
    label: Data files
    type: data

shortcodes: []

Field reference

Field	Required	Description
framework	Yes	hugo or astro
categories	Yes	Dropdown options in the editor
authors	Yes	Dropdown options in the editor
edit_zones	Yes	Which folders scribe can browse and edit
shortcodes	No	Hugo shortcodes. Set to [] for Astro

Edit zone fields

Field	Values	Description
path	any folder path	Relative from repo root
label	any string	Display name in sidebar
type	markdown or data	markdown = full editor. data = YAML/JSON editor