config.yaml

# Global mdv configuration
# Place this file at:
#   macOS:   ~/.config/mdv/config.yaml
#   Linux:   ~/.config/mdv/config.yaml
#   Windows: %APPDATA%/mdv/config.yaml
#
# Or create a local .mdv.yaml in your project directory for
# project-specific settings that override the global config.

# ============================================================
# THEME SETTINGS
# ============================================================

# TUI Theme for terminal markdown rendering
# Built-in themes: "dark", "light", "auto", "notty", "dracula", "pink", "tokyo-night"
# Or use a path to a custom JSON theme file:
#   - Absolute path: /path/to/theme.json
#   - Home path: ~/themes/custom.json
#   - Relative path: ./themes/custom.json (resolved relative to this config file's directory)
theme: auto

# Override TUI themes for light/dark mode when theme is set to "auto"
# This allows you to use custom themes while still benefiting from
# automatic system theme detection
# Leave empty to use default "light" and "dark" themes
# theme-light: notty
# theme-dark: tokyo-night
# Or use custom theme files:
# theme-light: ~/.config/mdv/themes/light-custom.json
# theme-dark: ~/.config/mdv/themes/dark-custom.json

# GUI Theme for desktop application rendering (mdv-gui)
# Built-in themes: "auto", "light", "dark"
# Or use a path to a custom CSS file:
#   - Absolute path: /path/to/theme.css
#   - Home path: ~/themes/custom.css
#   - Relative path: ./themes/custom.css (resolved relative to this config file's directory)
# gui-theme: auto

# Override GUI themes for light/dark mode when gui-theme is set to "auto"
# Leave empty to use default "light" and "dark" CSS themes
# gui-theme-light: light
# gui-theme-dark: dark
# Or use custom CSS theme files:
# gui-theme-light: ~/.config/mdv/themes/light-custom.css
# gui-theme-dark: ~/.config/mdv/themes/dark-custom.css

# ============================================================
# DISPLAY SETTINGS
# ============================================================

# Text wrap width for terminal rendering (TUI)
# Set to 0 to disable wrapping
wrap: 80

# Content width for GUI rendering
# Options: "narrow" (680px, optimal for reading), "medium" (900px, default),
#          "wide" (1200px, for tables/code), "full" (no constraint)
# Or specify a custom pixel value: "800"
# gui-width: medium

# Open in GUI mode by default
# Note: It's recommended to use the mdv-gui command directly for GUI mode
gui: false

# ============================================================
# LIVE RELOAD
# ============================================================

# Auto-reload on file changes
# Useful for live preview while editing
watch: false

# ============================================================
# EDITOR INTEGRATION
# ============================================================

# Editor to use when pressing 'e' in TUI or GUI
# Defaults to $EDITOR environment variable, or "vim" if not set
# Examples: "vim", "nvim", "nano", "code", "code --wait", "subl -w"
# editor: code

# ============================================================
# FILE EXCLUSION
# ============================================================

# Glob patterns for files to exclude when scanning directories
# Useful for ignoring drafts, temporary files, or specific documents
# exclude:
#   - README.md
#   - "draft-*.md"
#   - "*-tmp.md"
#   - "*-wip.md"

# ============================================================
# EXAMPLE CONFIGURATIONS
# ============================================================

# Example 1: Development/Writing Setup
# Automatically reload files while you edit them in your favorite editor
# ---
# theme: auto
# theme-dark: dracula
# wrap: 100
# watch: true
# editor: code --wait

# Example 2: Minimalist Terminal Setup
# Plain text rendering with no colors, narrower width
# ---
# theme: notty
# wrap: 60
# gui: false
# watch: false

# Example 3: Presentation Mode (GUI)
# Use specific themed appearance, optimized reading width
# ---
# gui: true
# gui-theme: auto
# gui-theme-light: light
# gui-theme-dark: dark
# gui-width: narrow
# watch: true

# Example 4: Technical Documentation (GUI)
# Wide layout for tables and code blocks with dark theme
# ---
# gui: true
# gui-theme: dark
# gui-width: wide
# watch: true

# Example 5: Project-specific (place in .mdv.yaml in your project)
# Exclude documentation files and drafts from directory browsing
# ---
# theme: auto
# theme-dark: pink
# gui-theme: dark
# gui-width: medium
# watch: true
# exclude:
#   - README.md
#   - CONTRIBUTING.md
#   - "*-draft.md"