MIDA API Reference

Complete reference documentation for MIDA theme APIs and components.

Core Components

Lucide Icon Helper

The lucide-icon.html partial provides intelligent icon rendering.

Usage:

1{{ partial "helpers/lucide-icon.html" (dict "name" "menu" "size" "lg") }}

Parameters:

• name (required): Icon name
• size (optional): xs, sm, base, lg, xl, 2xl, 3xl
• class (optional): Custom CSS classes
• stroke (optional): Stroke width (default: “2”)

Document Card Component

Renders document cards in list views.

Usage:

1{{ partial "components/docs-card.html" . }}

Context: Document page context

Tree Navigation

Hierarchical document navigation component.

Usage:

1{{ partial "sections/sidebars/docs-tree-nav.html" . }}

Helper Functions

Document Statistics

Access document statistics through front matter:

1stats:
2  view_count: 1500
3  like_count: 85
4  share_count: 12

Document Types

Supported document types:

• guide - Step-by-step guides
• tutorial - Learning tutorials
• reference - Technical reference
• api - API documentation
• faq - Frequently asked questions
• troubleshooting - Problem solving guides

Configuration

Site Parameters

1[params.docs]
2  [params.docs.features]
3    edit = true
4    print = true
5    search = true
6    comments = true

Front Matter Options

Essential front matter fields for docs:

1title: "Document Title"
2doc_type: "guide"
3status: "published"
4difficulty: "beginner"
5categories: ["Category"]
6tags: ["tag1", "tag2"]

Advanced Features

Collaboration

Enable multi-user editing:

1collaboration:
2  enable: true
3  editors: ["user1", "user2"]
4  permissions: "edit"

Version Control

Git integration settings:

1git:
2  branch: "main"
3  edit_url: "https://github.com/repo/edit/main/"

This API reference provides the essential information for developers working with the MIDA documentation system.