using-mashay

Installation
SKILL.md

Convert Markdown with mashay

mashay turns a Markdown file into one styled HTML file. It embeds the CSS, the logo, and any images directly in the file. The result is a single portable .html with no extra files beside it.

There is one exception. If a document has a Mermaid diagram, mashay loads code from a CDN to draw the diagram when you open the file. Only those files need internet access to view.

Working with mashay has two halves: running the CLI, and writing Markdown it understands. mashay documents itself. Its docs and --help output is the up-to-date reference for the exact rules, flags, and codes. This skill is your guide to that reference. It gives you the ideas that stay the same and the commands to look things up. It leaves the details, which shift as the CLI changes, to the CLI.

Running the CLI

The package is @draekien/mashay on npm. The command is mashay. Run it with npx @draekien/mashay …, or install it (globally or as a dev dependency) and run mashay directly. Run mashay on its own to print help. Run mashay --version to see the installed version — useful for checking which release npx picked.

Conversion is the process subcommand:

  • mashay process <src> builds right away. <src> is one .md file or a directory. A directory builds only its top-level .md files, not files in subdirectories.
  • mashay process with no source starts interactive mode. It searches the whole directory tree for .md files, groups them by folder, and asks which files to build and where to put them. (The direct form above searches only the top level.)

Each <file>.md becomes <file>.html in the output directory. Do not assume a fixed set of options — ask the CLI. mashay --help lists the subcommands. mashay process --help lists its flags and arguments (output directory, template, theme).

Installs
3
Repository
draekien/mashay
GitHub Stars
1
First Seen
Jul 21, 2026