bastian

bastian is a comprehensive terminal-based Markdown reader and file browser TUI designed to enhance the documentation experience directly in the terminal. It effortlessly discovers Markdown files in a specified folder, presenting them with features such as fitted tables, syntax-highlighted code, clickable links, images, a navigable table of contents, search functionality, and live reload capabilities.

Whether reading a single document or a collection of files, bastian supports multiple input methods, including local files, stdin, URLs, and even repositories from GitHub or GitLab. Code blocks from runbooks can be executed right within the application, making it an efficient tool for both reading and coding.

Key Features:

• File Browsing: Easily navigate through Markdown files in a directory, with options to filter by title or path, view hidden files, and customize the display layout.
• Document Reading: Utilize features such as a table of contents, section navigation, search capabilities, and clickable links.
• Interactive Editing: Open documents in an external editor and leverage live reload to see changes instantly.
• Thematic Options: Switch between various themes, or create custom ones to suit personal preferences.

Instant Access to Markdown:

bastian README.md           # Read a file in the TUI
bastian -                   # Read from stdin
cat notes.md | bastian      # Pipe input
bastian https://example.com/doc.md   # Read Markdown from a URL

Code Block Execution:

Execute code blocks natively within bastian with seamless output handling, allowing users to run scripts without leaving the reading environment. For instance:

echo "hello from $(basename "$PWD")"
uname -sm

Overall, bastian transforms the simple task of reading Markdown documentation into an engaging and productive experience, right from the terminal.