artempyanykh/marksman
Marksman
Marksman is a Language Server Protocol implementation for Markdown that provides advanced editor features including autocomplete, go-to-definition, and hover support for markdown files. It serves as an analysis engine to manage documentation and knowledge bases through automated link validation and consistent cross-referencing across multiple documents.
The project enables the navigation of complex networks of wiki-style links and headings. It supports content refactoring, allowing users to rename headings and update internal references across multiple files to maintain document integrity during restructuring.
The system provides real-time diagnostics to identify broken internal references and duplicate headings. It utilizes cross-document symbol indexing to resolve links and references across a set of files without scanning every document on every request.
Features
- Language Server Protocol Implementations - Implements the Language Server Protocol to provide editor intelligence, autocomplete, and go-to-definition for markdown files.
- Markdown-Based Knowledge Bases - Facilitates navigation of complex networks of wiki-style links and headings within a markdown-based knowledge base.
- Markdown Abstract Syntax Trees - Implements parsers that transform markdown text into structured abstract syntax trees for precise analysis and refactoring.
- Document Reference Validation - Detects broken wiki-links and duplicate or ambiguous headings through real-time diagnostics.
- Markdown Link Resolvers - Resolves cross-references between markdown files to enable navigation via completion, hover, and definition tools.
- Link Validation & Maintenance - Validates local links and identifies broken internal references in real time to ensure a functional documentation hierarchy.
- Document Node Modeling - Converts markdown text into a structured node tree to allow precise navigation and modification of content elements.
- Markdown Documentation Systems - Provides a system for managing large sets of markdown files with automated link validation and cross-referencing.
- Symbol Indexing - Generates symbol maps for headings and identifiers across multiple files to enable efficient cross-document navigation.
- Link Refactoring - Provides automated updating of internal document references and symbol renaming to maintain consistency across a document set.
- Incremental AST Updates - Modifies only the changed branches of the syntax tree to maintain performance during active document editing.
- Incremental Document Updates - Updates only the modified portions of the internal representation to maintain high performance during active editing.
- Diagnostic Engines - Triggers real-time validation checks when document content changes to identify broken links or duplicate headings.
- Diagnostic Pipelines - Triggers validation checks in response to content changes to identify broken links or duplicate headings in real time.
