neodocs

Overview

neodocs allows users to compose beautiful documents directly from their favorite terminal, enhancing productivity for those who prefer working in command-line environments such as NeoVim, Vim, or Emacs. This project addresses the limitations of conventional word-processing software, enabling the creation of aesthetically pleasing long-form documents in Markdown format, swiftly compiled into PDF files.

Key Features

• Simple Markdown Editing: Effortlessly write documents using Markdown syntax in any terminal-based text editor.
• Automatic PDF Generation: With every save, the tool auto-compiles Markdown files, producing well-formatted PDFs that retain the original filenames.
• Real-time Updates: A built-in file watcher can monitor changes to Markdown documents and automatically compile them, ensuring that modifications sync with the PDF in real-time.

Example Usage

Documents can include equations and complex formatting, easily demonstrated with the following resources:

• Example Document:
• Equations Support:

Getting Started

To set up neodocs, users need to install a few dependencies:

• Pandoc and BasicTex for document preparation and compilation.
• Skim for PDF viewing and Entr for monitoring file changes.

Installation commands include:

brew install basictex pandoc skim entr
npm install --global mermaid-filter

Usage Instructions

neodocs can be utilized in two primary ways:

1. Manual Compilation: Users create or edit any .md files, then execute ./compile.sh to convert modified Markdown files into PDFs.
2. Automatic Watching: Run the ./watcher.sh script to continuously monitor Markdown files for changes. Upon detection of edits, the compilation occurs automatically, streamlining the workflow.

Behind the Scenes

The compile script intelligently compares the last updated times of each Markdown file against their last compiled timestamps, ensuring that only changed files undergo recompilation. This efficient process avoids unnecessary overhead and maintains productivity.

neodocs is an innovative solution for developers and writers seeking a flexible, terminal-based approach to document creation, allowing for seamless integration into existing workflows without compromising on document quality.