$ show SidOfc/mkdx
mkdx is a Vim plugin that provides a comprehensive set of mappings and functions for editing Markdown files. It handles list insertion, checkbox toggling with hierarchical state updates, header promotion/demotion, text wrapping (bold, italic, code, strikethrough, links), CSV-to-table conversion, dead link detection (fragment and external via async curl), table of contents generation (including nested `<details>` tags), fenced code block insertion, quote toggling, and enhanced `gf`/`gx` navigation. The plugin is highly configurable through a single `g:mkdx#settings` dictionary with runtime validation and auto-update via `dictwatcheradd`. It includes a full test suite using Vader.vim and supports both Vim and Neovim. The architecture follows standard Vim plugin conventions with `plugin/`, `ftplugin/`, `autoload/`, and `after/syntax/` directories, demonstrating advanced Vimscript patterns such as asynchronous job control, deep merge of settings, and dynamic syntax highlighting.
The LLM identified 5 files worth highlighting for reuse:
The `s:util.CsvRowToList` function (lines ~300-330) implements a robust CSV row parser that handles quoted fields, escaped quotes, and tab separators. It is self-contained, has no external dependencies, and can be extracted into a standalone utility for any Vim plugin needing CSV parsing. The function iterates character-by-character, correctly managing quote state and escape sequences, making it a reliable building block for data import features.
The `mkdx#MergeSettings` function (lines ~600-620) provides a generic deep merge algorithm for nested dictionaries, supporting both creation and modification modes. It recursively merges keys from a source hash into a target, preserving existing values when not overridden. This pattern is essential for plugin configuration systems and can be reused in any Vim project that needs to merge user settings with defaults without losing structure.
The `s:util.WrapSelectionOrWord` function (lines ~250-280) implements a generic text wrapping utility that works in both normal and visual modes, supports a count to wrap multiple words, and includes intelligent toggle detection: if the cursor is already inside a wrapped region (e.g., bold markers), it unwraps instead. This dual behavior is achieved by checking syntax highlight groups at the cursor position, making it a reusable pattern for any markup language plugin that needs togglable formatting.
The `s:util.UpdateTaskList` function (lines ~450-480) implements an algorithm to automatically update parent and child checkbox states in a hierarchical task list. When a checkbox is toggled, it traverses up to find parent items and recalculates their state based on all children (completed if all children done, pending if any in-progress, empty if none started). It also optionally forces child states to match the toggled item. This logic is self-contained and could be extracted for any application managing nested checklists.
This syntax file enhances Markdown highlighting with support for tables, checkbox states (empty, pending, complete), `<kbd>` tags, bold-italic combinations, inline code, tilde fenced blocks, CriticMarkup, and YAML/TOML/JSON frontmatter. It demonstrates how to conditionally include external syntax files (e.g., `yaml.vim`) for frontmatter regions, and how to define highlight groups that link to existing color schemes. The file is a reference for writing modular, configurable Vim syntax definitions.