Skip to content

Interpoolx/mdoc-cli

Repository files navigation

mdoc-cli

A high-performance Markdown CLI tool built with Go, distributed via NPM.

Features

  • Blazing Fast: Sub-50ms startup time.
  • Multi-platform: Native binaries for Windows, Linux, and macOS.
  • Conversion: Convert Markdown to HTML, JSON, and more.
  • Batch Processing: Process entire directories concurrently.
  • Zero Dependencies: Single binary execution.

Release a new version

npm run publish-version 1.0.1

This automates versioning, cross-platform Go builds, and NPM publication.

Installation

npx mdoc-cli --help

Or install globally:

npm install -g mdoc-cli@latest

Usage

Convert Markdown to HTML

# Using npx (Recommended)
npx mdoc-cli convert README.md -o output/README.html

# If installed globally
mdoc-cli convert README.md -o output/README.html

Batch Conversion

npx mdoc-cli convert --recursive examples/ -o output/

Validate Markdown

npx mdoc-cli validate README.md

Configuration

mdoc-cli can be configured via flags, environment variables, or a mdoc-cli.yaml file.

verbose: true
theme: dark

Platform Support

mdoc-cli handles platform-specific binaries automatically via the NPM wrapper:

  • Windows: Executes md-cli-windows-amd64.exe
  • Linux: Executes md-cli-linux-amd64 (x64)
  • macOS: Executes md-cli-darwin-arm64 (Apple Silicon)

License

MIT © Interpoolx

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published