bgreenwell/doxx
Doxx
Doxx is a collection of shell-based tools for parsing, viewing, and converting word processing files. It provides a terminal user interface for reading and searching DOCX files without requiring external office software, functioning as both a terminal document viewer and a command line parser.
The project distinguishes itself by offering a full TUI document reader with outline navigation and the ability to export document content and metadata into alternative formats such as Markdown, CSV, JSON, and plain text.
The system covers a broad range of capabilities including document metadata analysis, content extraction, and terminal-based rendering of formatted text, tables, lists, and equations. It also includes tools for managing document images through inline display or local file extraction and a search utility for locating and highlighting text patterns within documents.
Features
- Terminal Document Viewers - Provides a full terminal user interface for reading and navigating DOCX files without external office software.
- Open - Extracts structural content by traversing the underlying Open XML format of DOCX files.
- Document Viewers - Implements a terminal-based application for reading and searching Word documents without office software.
- Multi-Format Exports - Exports document data into multiple distinct formats including Markdown, CSV, JSON, and plain text.
- Document to Markdown Converters - Converts structured content from DOCX files into formatted Markdown and other text-based formats.
- DOCX Parsers - Extracts structural data, images, and metadata from Word files directly from the shell.
- Markdown Content Extraction - Converts rich Word document structures into Markdown, JSON, CSV, or plain text for use in other scripts.
- Schema-Driven Data Export - Maps internal document structures to standardized formats like Markdown, JSON, and CSV using predefined templates.
- ANSI Terminal UI Libraries - Renders formatted text, tables, and layouts directly in the terminal using ANSI escape sequences.
- Terminal Content Rendering - Renders formatted text, tables, lists, and equations from documents directly within a terminal interface.
- Document Content Search - Includes a search utility to locate and highlight specific strings or patterns within DOCX files directly from the command line.
- Document Metadata Extraction - Retrieves structural and descriptive properties like author and title from document file properties.
- Image Management - Handles the display of images inline within the terminal or extracts them to local directories.
- In-Document Text Search - Enables iterative searching of strings and patterns within a document buffer using a terminal interface.
- Document Outline Navigation - Provides an outline view and page-jumping toolset for navigating long documents efficiently.
- Word - Retrieves structural information and file properties from Word documents for reporting and data processing.
- Interface Presets - Allows users to define standardized keyboard shortcuts and interface behaviors through configuration presets.
- Input Mapping Systems - Provides a customizable system to map keyboard inputs to application commands via configuration files.
- Miscellaneous Utilities - Document viewer for Microsoft Word files.
Star history
How this analysis was created: This summary and feature list were written by an AI model that read the project's README and public documentation pages. Each feature links to the documentation it came from; stars, license and language come straight from the GitHub API. The model does not read the source code, and the analysis is refreshed when the project is re-analysed. Learn more on our About page.
