bastian

bastian: A Terminal Markdown Reader and File Browser TUI

bastian enhances the way documentation is read directly in the terminal, transforming Markdown files into visually appealing, structured presentations. It supports features like fitted tables, syntax-highlighted code, clickable links, images, a convenient table of contents, search capabilities, and live reload functionality.

Key Features

• Folder Navigation: Launch bastian in any directory to view Markdown files, sorted by recency. Key functions include:

  • j/k for navigation through the file list, / to filter by path or title, Enter to open files, and e to edit.
  • Options to view hidden or ignored files, shape the display to preference, and sort by modified or creation date.

• Reading Experience:

  • Access a table of contents (t), search within documents (/), and navigate headings effortlessly with 1-9 and 0 for section jumps.
  • Quick access to links and previous document history, alongside options to edit live and reload changes automatically.

• Markdown Rendering:

  • Supports diverse Markdown features such as fitted tables, task lists, footnotes, and even mathematical notations. It also correctly renders images, highlights, and inline HTML tags.
  • Advanced handling of GitHub-style alerts and CJK texts enhances readability and usability.

Code Execution

bastian allows for inline execution of code blocks from various languages, with results displayed directly underneath. Users can easily run shell, Python, and Node blocks, making coding and documentation review seamless.

Theming and Configuration

With multiple built-in themes, bastian ensures optimal readability in any environment. Users can switch themes dynamically and even create custom styles. Configuration options are flexible, accommodating modifications through environment variables and configuration files.

Documentation and Command Line Options

Comprehensive documentation covers every aspect of using bastian, from browsing and reading Markdown files, to configuration and theme management.

Getting Started

To start using bastian, install it via Homebrew or Cargo, and explore the robust features aimed at improving documentation readability in terminal environments.

For more detailed operations and examples, refer to the official documentation.

Explore how bastian can enhance your Markdown reading experience and streamline your documentation processes.