NAME

mdee - Markdown, Easy on the Eyes

SYNOPSIS

mdee [ options ] file ...

 -h  --help             show help
     --version          show version
 -d  --debug            debug level (repeatable)
 -n  --dryrun           dry-run mode
 -f  --filter           filter mode (highlight only)
     --[no-]fold        line folding (default: on)
     --[no-]table       table formatting (default: on)
     --[no-]nup         nup paged output (default: on)
 -w  --width=#          fold width (default: 80)
 -t  --theme=#          color theme
 -m  --mode=#           light or dark (default: light)
 -B  --base-color=#     override theme's base color
                        (e.g., <Red>, #FF5733, hsl(0,100,50))
     --list-themes      list built-in themes
     --enable=#         enable only specified fields
     --disable=#        disable specified fields
 -C  --pane=#           number of columns
 -R  --row=#            number of rows
 -G  --grid=#           grid layout (e.g., 2x3)
 -P  --page=#           page height in lines
 -S  --pane-width=#     pane width (default: 85)
--bs --border-style=#   border style
     --[no-]pager[=#]   pager command

VERSION

Version 0.01

DESCRIPTION

mdee is a multi-column Markdown viewer with syntax highlighting, combining greple(1) for colorization and nup(1) for paged output.

Supported elements: headers (h1-h5), bold, strikethrough, inline code, code blocks, HTML comments, tables, and list items.

This tool is designed for viewing Markdown not constrained by display formatting, such as output from LLMs (Large Language Models). It applies syntax highlighting with line folding and table alignment, but does not reflow paragraphs with hard line breaks. For full Markdown rendering, many other viewers are available. Combine them with nup(1) for similar paged output (e.g., nup glow README.md).

OPTIONS

General Options

-h, --help: Show help message.
--version: Show version.
-d, --debug: Set debug level. Can be repeated (-d, -dd, -ddd) for increasing verbosity.
-n, --dryrun: Dry-run mode. Show the command without executing.
-f, --filter: Filter mode. Reads from stdin (or files) and outputs highlighted Markdown to stdout. Disables line folding, table formatting, and nup paged output. Useful for piping Markdown content through mdee for syntax highlighting only.

Processing Options

--[no-]fold: Enable or disable line folding for list items. When enabled, long lines in list items are wrapped with proper indentation using ansifold(1). Default is enabled.
--[no-]table: Enable or disable table formatting. When enabled, Markdown tables are formatted using ansicolumn(1) for aligned column display. Default is enabled.
--[no-]nup: Enable or disable nup(1) for multi-column paged output. When disabled, output goes directly to stdout without formatting. Default is enabled.
-w N, --width=N: Set the fold width for text wrapping. Default is 80. Only effective when --fold is enabled.

Theme Options

mdee supports color themes for customizing syntax highlighting. Themes define colors for various Markdown elements (headers, code blocks, bold text, etc.).

-t NAME, --theme=NAME

Select a color theme. Default is default.

-m MODE, --mode=MODE

Select light or dark mode. Default is light.

If the terminal supports background color detection (via Getopt::EX::termcolor), the mode is automatically selected based on terminal luminance.

Each theme has light and dark variants optimized for different terminal backgrounds. The built-in default theme provides:

light - Navy blue base color for light backgrounds
dark - Light blue (#CCCDFF) base color for dark backgrounds

User configuration is loaded from:

${XDG_CONFIG_HOME:-~/.config}/mdee/config.sh

This is a shell script that can set defaults and override colors:

# ~/.config/mdee/config.sh
default_mode='dark'              # set default mode
colors[base]='<DarkCyan>'        # override base color
colors[h1]='L25DE/${base}'       # header with base background

Color specifications use Term::ANSIColor::Concise format. The FG/BG notation specifies foreground and background colors (e.g., L25DE/${base} means gray foreground on base-colored background). The ${base} string is expanded to the base color value after loading.

-B COLOR, --base-color=COLOR

Override the theme's base color. This is useful for quickly adjusting the color scheme without creating a custom theme. Accepts Term::ANSIColor::Concise color specifications:

Color names: <Red>, <NavyBlue>
RGB hex: #FF5733
RGB decimal: rgb(255,87,51)
HSL: hsl(0,100,50)

Note: Basic ANSI color codes (R, G, B, etc.) are not supported because the highlighting variations are created by adjusting lightness of the base color, which requires full color specifications.

--list-themes

List built-in themes with color samples and exit.

Highlight Options

--enable=FIELD,...

Enable only specified fields for highlighting. All other fields are disabled. Multiple fields can be specified with commas or by repeating the option.

Available fields: comment, bold, strike, h1, h2, h3, h4, h5, inline_code, code_block.

--disable=FIELD,...

Disable specified fields from highlighting. All other fields remain enabled. Multiple fields can be specified with commas or by repeating the option.

Layout Options (passed to nup)

-C N, --pane=N: Set the number of columns (panes).
-R N, --row=N: Set the number of rows.
-G CxR, --grid=CxR: Set grid layout. For example, -G2x3 creates 2 columns and 3 rows.
-P N, --page=N: Set the page height in lines.
-S N, --pane-width=N: Set the pane width in characters. Default is 85.
--bs=STYLE, --border-style=STYLE: Set the border style.

--[no-]pager[=COMMAND]: Set the pager command. Use --pager=less to specify a pager, or --no-pager to disable paging.

EXAMPLES

mdee README.md              # view markdown file
mdee -C2 document.md        # 2-column view
mdee -G2x2 manual.md        # 2x2 grid (4-up)
mdee -w60 narrow.md         # narrower text width
mdee --no-pager file.md     # without pager
mdee --no-nup file.md       # output to stdout without nup
mdee --no-fold file.md      # disable line folding
mdee --no-table file.md     # disable table formatting

# Filter mode
cat file.md | mdee -f       # highlight stdin
mdee -f file.md             # highlight only (no paging)

# Theme examples
mdee --mode=dark file.md             # use dark mode
mdee --mode=light file.md            # use light mode
mdee -B '<Red>' file.md              # override base color
mdee --mode=dark -B '<Cyan>' file.md # dark mode with cyan base
mdee --list-themes                   # list available themes

DEPENDENCIES

This command requires the following:

App::Greple - pattern matching and highlighting
App::Greple::tee - filter integration
App::ansifold - ANSI-aware text folding
App::ansicolumn - ANSI-aware column formatting
App::nup - N-up multi-column paged output
App::ansiecho - ANSI color output
Getopt::Long::Bash - bash option parsing
Getopt::EX::termcolor - terminal background detection

IMPLEMENTATION

mdee is implemented as a Bash script that orchestrates multiple specialized tools into a unified pipeline. The architecture follows Unix philosophy: each tool does one thing well, and they communicate through standard streams.

The overall data flow is:

Input File
    |
    v
[greple] --- Syntax Highlighting
    |
    v
[ansifold] --- Text Folding (optional)
    |
    v
[ansicolumn] --- Table Formatting (optional)
    |
    v
[nup] --- Paged Output (optional)
    |
    v
Terminal/Pager

Pipeline Architecture

mdee dynamically constructs a pipeline based on enabled options. Each stage is represented as a Bash array containing the command and its arguments. The `--dryrun` option displays the constructed pipeline without execution.

Processing Stages

The pipeline consists of four configurable stages. Each stage can be enabled or disabled independently using `--[no-]fold`, `--[no-]table`, and `--[no-]nup` options.

Syntax Highlighting

The first stage uses greple(1) with the `-G` (grep mode) and `--ci=G` (capture index) options to apply different colors to each captured group in regular expressions.

Supported Markdown elements:

- Headers (`# h1` through `##### h5`) - Bold text (`**bold**`) - Inline code (`` `code` ``) - Code blocks (fenced with ``` or ~~~) - HTML comments (``)

Code block detection follows the CommonMark specification:

- Opening fence: 0-3 spaces indentation, then 3+ backticks or tildes - Closing fence: 0-3 spaces indentation, same character, same or more count - Backticks and tildes cannot be mixed (``` must close with ```)

Color Specifications

Colors are specified using Term::ANSIColor::Concise format. The `--cm` option maps colors to captured groups. For example, `L00DE/${base}` specifies gray foreground on base-colored background.

The color specification supports modifiers:

- `+l10` / `-l10`: Adjust lightness by percentage - `=l50`: Set absolute lightness - `D`: Bold, `U`: Underline, `E`: Erase line

Example greple invocation:

greple -G --ci=G --all --need=0 \
    --cm 'L00DE/${base}' -E '^#\h+.*' \
    --cm '${base}D' -E '\*\*.*?\*\*' \
    file.md

Text Folding

The second stage wraps long lines in list items using ansifold(1) via Greple::tee. It preserves ANSI escape sequences and maintains proper indentation for nested lists.

The folding width is controlled by `--width` option (default: 80).

Table Formatting

The third stage formats Markdown tables using ansicolumn(1). Tables are detected by the pattern `^(\|.+\|\n){3,}` and formatted with aligned columns while preserving ANSI colors.

Output Stage

The final stage uses nup(1) to provide multi-column paged output. Layout options (`--pane`, `--row`, `--grid`, `--page`) are passed directly to nup.

Theme System

mdee implements a theme system with light and dark mode variants.

Theme Structure

Each theme is defined as a Bash associative array with color definitions for each Markdown element:

declare -A theme_default_dark=(
    [base]='#CCCDFF'
    [h1]='L00DE/${base}'
    [h2]='L00DE/${base}-l10'
    ...
)

Base Color Expansion

The `${base}` placeholder in color values is expanded after theme loading. This allows derived colors to be calculated from a single base color, making theme customization easier.

Terminal Mode Detection

mdee uses Getopt::EX::termcolor to detect terminal background luminance. If luminance is below 50%, dark mode is automatically selected.

AUTHOR

Kazumasa Utashiro

LICENSE

This software is released under the MIT License. https://opensource.org/licenses/MIT

To install App::mdee, copy and paste the appropriate command in to your terminal.

cpanm

cpanm App::mdee

CPAN shell

perl -MCPAN -e shell
install App::mdee

For more information on module installation, please visit the detailed CPAN module installation guide.

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)