lervag/vimtex
Vimtex
VimTeX is an integrated development environment for authoring and compiling LaTeX documents within Vim and Neovim. It functions as a comprehensive suite for technical document authoring, combining the roles of a syntax highlighter, document navigator, and autocompletion engine.
The plugin distinguishes itself through a coordinated workflow that manages asynchronous compilation and bidirectional synchronization with external PDF viewers. This allows users to jump between specific source locations and their rendered pages while maintaining a responsive editor interface during document production.
The system provides a broad range of capabilities for document intelligence and editing. This includes context-aware suggestions for citations and labels, a navigable table of contents for traversing large files, and specialized text objects that treat LaTeX environments and math zones as atomic units. It also parses compilation logs to map errors and warnings directly to the corresponding lines in the source code.
Features
- LaTeX IDE Integrations - Provides a complete integrated development environment for authoring and formatting complex LaTeX documents within Vim and Neovim.
- Vim Plugins - Implements a comprehensive IDE for authoring and compiling LaTeX documents as an extension for Vim and Neovim.
- LaTeX Compilation Workflows - Provides an integrated LaTeX compilation workflow that processes source files and parses resulting error logs.
- Log-to-Source Mapping - Maps compilation log errors and warnings directly to the corresponding line numbers in the source code.
- Asynchronous Task Processing - Manages long-running LaTeX compilation tasks in the background to keep the editor interface responsive.
- Bidirectional Source Synchronization - Provides bidirectional source synchronization between the editor and external PDF viewers for mutual navigation.
- LaTeX Command Completion - Provides contextual suggestions for LaTeX packages, classes, and unicode glyphs.
- Document Element Completions - Suggests completions for citations, labels, glossary entries, and included filenames.
- Custom Text-Object Definitions - Extends the editor's selection system to treat LaTeX environments and math zones as atomic units.
- Environment Management Tools - Provides specialized editing tools and syntax support to streamline authoring complex technical documents.
- Syntax Highlighting - Provides advanced coloring and structural nesting for LaTeX source code and packages to improve readability.
- LaTeX Synchronized Viewers - Synchronizes the text editor with a document viewer to jump between source locations and rendered pages.
- LaTeX - Enables traversing sections and references via a table of contents and bidirectional source-to-PDF jumps.
- Compilation Log Integration - Parses external compilation logs to populate the editor's quickfix list with mapped errors and warnings.
- Text Object Selection - Provides specialized text objects for environments and math blocks for rapid document modification.
- Context-Aware Suggestions - Offers context-aware suggestions for LaTeX commands, citations, and labels based on the current cursor position.
- Text Object Extensions - Defines new text objects to allow precise selection and manipulation of LaTeX structural elements.
- Syntax Highlighters - Provides advanced syntax highlighting with hierarchical coloring rules for LaTeX source and package structures.
- Structural Delimiter Detection - Identifies and manipulates the boundaries of LaTeX environments and mathematical delimiters.
- LaTeX Command Analysis - Analyzes the surrounding text to determine the arguments and scope of specific LaTeX commands.
- Documentation Navigation - Provides a navigable table of contents and jumping mechanisms to traverse large LaTeX documents.
- Document Structure Navigators - Provides hierarchical navigation between section boundaries, environments, and math blocks within LaTeX documents.
- Automatic Table of Contents - Displays a toggleable, automatically generated list of sections for quick inspection and navigation of the document.
- Element Variant Toggles - Allows quick switching between related LaTeX states, such as starred and non-starred environments.
- File Indexing Utilities - Uses file-system indexing to build a navigable table of contents and a map of labels and references.
- Document Indexing - Scans source files to build a navigable table of contents and a map of labels and references.
- LaTeX Linters - Performs static analysis of LaTeX source to identify syntax and grammar errors.
- PDF Viewer Integrations - Integrates with third-party PDF software via command-line arguments to enable forward and backward search.
- Regex-Based Syntax Highlighting - Uses regular expression pattern matching to apply coloring and nesting rules to complex LaTeX structures.
- Scholarly Reference Navigators - Facilitates jumping between academic references, including citations, figures, and file-based include expressions.
- Surrounding Character Management - Allows deleting or changing surrounding LaTeX commands and environments while preserving the enclosed content.
- Syntax Transformation Utilities - Enables toggling between starred commands, inline math, and display math via dedicated shortcuts.
- Custom Text-Object Definitions - Defines custom text objects that treat LaTeX environments and math zones as atomic units for selection.
- Asynchronous Task Orchestration - Implements asynchronous task orchestration to handle background compilation without freezing the editor interface.
- Structural Folding - Collapses LaTeX environments and structural elements to simplify navigation of large files.
- Compiler Error Navigation - Maps LaTeX compilation errors from log files directly back to specific lines in the source code.
- Regular Expression-Based Parsing - Employs regular expression-based parsing to identify LaTeX commands and their associated argument scopes.
- Editor Plugins - Modern Vim plugin featuring live preview and forward search.
