Server¶

The [server] section configures the language server that powers the VS Code extension and other editor integrations. Adjust these settings to balance productivity features against performance on large projects.

Minimal example¶

[server]
hover_images = true
hover_need_refs = true
index_on_save = false

Options¶

hover_images

Type: boolean (default: true)

When enabled, hovering over image/figure directive arguments in the editor will show a preview of the image.

hover_need_refs

Type: boolean (default: true)

When enabled, hovering over need references (like :need:`REQ_001`) will show a tooltip with need information.

index_on_save

Type: boolean (default: false)

When enabled, the language server will automatically reindex the entire project whenever a source document is saved. This keeps need references and cross-links up to date but may impact performance on large projects.

Note

Enabling this feature ensures that need references are always current but may slow down save operations on large projects.

image_file_patterns

Type: array (default: extensive list of image formats)

List of glob patterns that define which files are considered images. Used for:

Autocompletion in image and figure directives
Image preview in hover tooltips
File discovery for image-related features

Default patterns include common formats like:

image_file_patterns = [
    "*.jpg", "*.jpeg", "*.png", "*.gif", "*.svg",
    "*.webp", "*.bmp", "*.tiff", "*.tif", "*.ico",
    "*.heif", "*.heic", "*.avif", "*.eps", "*.psd",
    "*.ai", "*.pdf"
]

Performance considerations¶

For large projects, consider these settings:

[server]
# Disable automatic indexing for better performance
index_on_save = false

# Keep hover features for productivity
hover_images = true
hover_need_refs = true

# Limit image patterns to only used formats
image_file_patterns = ["*.png", "*.jpg", "*.svg"]