MDCLI v2.0 - Advanced Markdown CLI Processor

mdcli is a powerful, feature-rich command-line tool for processing and rendering Markdown files. It provides advanced capabilities including live preview, batch processing, multiple output formats, and extensive customization options.

Backward Compatibility: mdcli v2.0 maintains full backward compatibility. You can still use mdcli file.md directly without the render subcommand.

Features

Multiple Output Formats

Terminal: High-quality terminal rendering with syntax highlighting
HTML: Clean HTML output with customizable themes
PDF: Export to PDF format (planned)
Plain Text: Strip formatting for plain text output

Theme Support

Built-in Themes: Dracula, GitHub, Monokai, Solarized, and Nord
Customizable Colors: Override theme colors via configuration
Syntax Highlighting: Advanced code highlighting with multiple styles

Live Features

Watch Mode: Automatic regeneration on file changes
Live Preview Server: Browser-based live preview with auto-reload
Interactive Mode: Real-time Markdown editor within the terminal

Performance and Productivity

Batch Processing: Process entire directories concurrently
Progress Monitoring: Visual feedback for long-running operations
Concurrent Workers: Configurable parallel processing
Intelligent Caching: Optimized performance for repeated tasks

Advanced Markdown Support

Math Equations: LaTeX math rendering with MathJax
Mermaid Diagrams: Support for flowcharts and diagrams
GitHub Flavored Markdown: Tables, task lists, and strikethrough
Auto-linking: Automatic URL and email detection

Configuration

YAML Configuration: Persistent settings via ~/.mdcli.yaml
Environment Variables: Override settings with MDCLI_* variables
Command-line Flags: On-the-fly overrides for any setting

Quick Start

Installation

From Source

git clone https://github.com/tacheraSasi/mdcli.git
cd mdcli
make build

macOS (Apple Silicon)

curl -L https://github.com/tacheraSasi/mdcli/releases/latest/download/mdcli-darwin-arm64.tar.gz -o mdcli-darwin-arm64.tar.gz
sudo tar -C /usr/local/bin -xzf mdcli-darwin-arm64.tar.gz
rm mdcli-darwin-arm64.tar.gz

macOS (Intel)

curl -L https://github.com/tacheraSasi/mdcli/releases/latest/download/mdcli-darwin-amd64.tar.gz -o mdcli-darwin-amd64.tar.gz
sudo tar -C /usr/local/bin -xzf mdcli-darwin-amd64.tar.gz
rm mdcli-darwin-amd64.tar.gz

Linux (amd64)

curl -L https://github.com/tacheraSasi/mdcli/releases/latest/download/mdcli-linux-amd64.tar.gz -o mdcli-linux-amd64.tar.gz
sudo tar -C /usr/local/bin -xzf mdcli-linux-amd64.tar.gz
rm mdcli-linux-amd64.tar.gz

Linux (arm64)

curl -L https://github.com/tacheraSasi/mdcli/releases/latest/download/mdcli-linux-arm64.tar.gz -o mdcli-linux-arm64.tar.gz
sudo tar -C /usr/local/bin -xzf mdcli-linux-arm64.tar.gz
rm mdcli-linux-arm64.tar.gz

Windows

Download the latest .zip from the releases page, extract it, and add mdcli.exe to your PATH.

Android (Termux)

curl -L https://github.com/tacheraSasi/mdcli/releases/latest/download/mdcli-android-arm64.tar.gz -o mdcli-android-arm64.tar.gz
tar -xzf mdcli-android-arm64.tar.gz -C $PREFIX/bin
rm mdcli-android-arm64.tar.gz

Basic Usage

# Simple rendering (backward compatible)
./mdcli README.md

# With flags (backward compatible)
./mdcli README.md --theme=github --format=html

# Explicit render command
./mdcli render README.md

# Render with custom theme
./mdcli render --theme=github README.md

# Output to HTML
./mdcli render --format=html --output=output.html README.md

# Start live preview server
./mdcli serve README.md --port=8080

# Watch for changes
./mdcli watch README.md --output=preview.html

# Interactive mode
./mdcli interactive

# Batch process directory
./mdcli batch ./docs --output=./dist --recursive

# View available themes
./mdcli themes

Command Reference

Core Commands

Command	Description	Example
`render`	Render Markdown files	`mdcli render file.md`
`serve`	Start live preview server	`mdcli serve file.md`
`watch`	Watch files for changes	`mdcli watch file.md`
`batch`	Process multiple files	`mdcli batch ./docs`
`interactive`	Interactive editor mode	`mdcli interactive`
`themes`	List available themes	`mdcli themes`
`config`	Manage configuration	`mdcli config show`

Global Flags

Flag	Description	Default
`--config`	Config file path	`~/.mdcli.yaml`
`--verbose`	Verbose output	`false`
`--theme`	Syntax theme	`dracula`
`--format`	Output format	`terminal`
`--width`	Terminal width	`80`

Render Command Options

mdcli render [files...] [flags]

Flags:
  -f, --format string   Output format (terminal, html, pdf, text)
  -o, --output string   Output file path
  -t, --theme string    Syntax highlighting theme
  -w, --width int       Terminal width for formatting
      --autolink        Enable automatic link detection (default true)
      --progress        Show progress bar for multiple files

Serve Command Options

mdcli serve [file] [flags]

Flags:
  -p, --port int        Port to serve on (default 8080)
  -b, --bind string     Bind address (default "localhost")
      --auto-reload     Enable auto-reload on file changes (default true)
  -t, --theme string    Theme for HTML output (default "github")

Batch Command Options

mdcli batch [directory] [flags]

Flags:
  -o, --output string      Output directory
  -f, --format string      Output format (default "html")
  -r, --recursive          Process subdirectories recursively
  -c, --concurrent int     Number of concurrent workers (default 4)
  -e, --ext string         Output file extension (default ".html")

Configuration

Configuration File

Manage your settings using the built-in configuration tool:

# Initialize default config
mdcli config init

# View current configuration
mdcli config show

Sample Configuration (`~/.mdcli.yaml`)

# Default theme for syntax highlighting
theme: dracula

# Default output format
output_format: terminal

# Default terminal width
width: 80

# Enable automatic link detection
autolink: true

# Batch processing settings
batch:
  concurrent_workers: 4
  output_extension: .html
  recursive: true

# Server settings
serve:
  port: 8080
  bind: localhost
  auto_reload: true

# Rendering preferences
render:
  show_progress: true
  include_metadata: false

Environment Variables

Settings can be overridden using environment variables:

export MDCLI_THEME=github
export MDCLI_WIDTH=100
export MDCLI_FORMAT=html

mdcli render README.md

Themes

mdcli includes several professionally designed built-in themes:

Theme	Description	Best For
Dracula	Dark theme with purple accents	Dark mode environments
GitHub	Light theme inspired by GitHub	Documentation
Monokai	Dark theme with vibrant colors	Code-heavy documents
Solarized	Balanced light/dark theme	Visual comfort
Nord	Arctic, north-bluish palette	Modern interfaces

# List all available themes
mdcli themes

# Use a specific theme
mdcli render --theme=nord README.md

Advanced Features

Math Equations

Supports LaTeX math equations via MathJax:

Inline math: $E = mc^2$

Block math:

$$
\int_{-\infty}^{\infty} e^{-x^2} dx = \sqrt{\pi}
$$

Mermaid Diagrams

Native support for flowcharts and diagrams:

\```mermaid
graph TD
A[Start] --> B{Decision}
B -->|Yes| C[Action 1]
B -->|No| D[Action 2]
\```

Live Preview

Real-time browser-based preview:

# Start server
mdcli serve README.md --port=8080

# The server will automatically reload when files are saved.

Building from Source

Prerequisites

Go 1.24 or later
Make (optional)

Build Commands

# Build for the current platform
make build

# Build for all platforms
make build-all

# Individual platform builds
make build-darwin    # macOS (arm64 + amd64)
make build-linux     # Linux (amd64 + arm64)
make build-windows   # Windows (amd64 + arm64)
make build-android   # Android (arm64)

# Create a GitHub release with all binaries
make release

Contributing

Contributions are welcome. Please refer to the Contributing Guidelines for further details.

Changelog

v2.0.0

Complete migration to the Cobra CLI framework
Support for multiple output formats (HTML, PDF, Text)
Enhanced theme system with 5 built-in options
Integrated live preview server with auto-reload
Concurrent batch processing
Support for MathJax and Mermaid diagrams
Comprehensive YAML-based configuration

v1.0.0

Initial release with basic Markdown rendering
Terminal output support

Support

Email: tacherasasi@gmail.com
Issues: GitHub Issues
Discussions: GitHub Discussions

Developed by Tachera Sasi

Name		Name	Last commit message	Last commit date
Latest commit History 68 Commits
assets		assets
batch_output		batch_output
cmd		cmd
components		components
renderer		renderer
themes		themes
ui		ui
utils		utils
.gitignore		.gitignore
.templui.json		.templui.json
LICENSE		LICENSE
Makefile		Makefile
README.md		README.md
Taskfile.yml		Taskfile.yml
assets.go		assets.go
go.mod		go.mod
go.sum		go.sum
main.go		main.go
package-lock.json		package-lock.json
package.json		package.json
test.md		test.md
upx		upx

Folders and files

Latest commit

History

Repository files navigation

MDCLI v2.0 - Advanced Markdown CLI Processor

Features

Multiple Output Formats

Theme Support

Live Features

Performance and Productivity

Advanced Markdown Support

Configuration

Quick Start

Installation

From Source

macOS (Apple Silicon)

macOS (Intel)

Linux (amd64)

Linux (arm64)

Windows

Android (Termux)

Basic Usage

Command Reference

Core Commands

Global Flags

Render Command Options

Serve Command Options

Batch Command Options

Configuration

Configuration File

Sample Configuration (~/.mdcli.yaml)

Environment Variables

Themes

Advanced Features

Math Equations

Mermaid Diagrams

Live Preview

Building from Source

Prerequisites

Build Commands

Contributing

Changelog

v2.0.0

v1.0.0

Support

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases 2

Packages 0

Uh oh!

Uh oh!

Contributors

Uh oh!

Languages

Sample Configuration (`~/.mdcli.yaml`)

Packages