Skip to content
/ moth Public

A CLI tool for converting a custom markdown-inspired format into HTML with support for inline math, embedded images, and live reload

Notifications You must be signed in to change notification settings

azomDev/moth

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

12 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Moth

Moth is a fast CLI tool for converting .moth files — a markdown-inspired format — into HTML. It supports inline math, embedded images, raw HTML blocks, and live reload for rapid editing.

Important

Moth is currently in its early stages. If you find any problem/bugs, feel free to open an issue. However, I won't be taking any feature requests for now as this is mainly a personal project I am making available to everyone.

Usage

Transpile a .moth file into HTML

moth transpile myfile.moth

Options:

  • --no-base-64 — disables image base64 embedding (uses file references instead)
  • --out-file <file> — sets the output HTML file name (default: output.html)

Live-reload server

moth serve myfile.moth

Options:

  • --ws-port <port> — websocket port (default: 8000)
  • --http-port <port> — HTTP port (default: 8001)

Syntax

The Moth syntax is close to Markdown. Documentation for it will be added here at some point.

Installation

I might try making it easier at some point, but for now you must use cargo to compile this into a binary you can use as moth.

Contributing

If you'd like to contribute to Moth, feel free to check out the repository. However, please note that feature requests are not being accepted at this time. If you're interested in helping with improvements or fixes, your contributions are welcome!

About

A CLI tool for converting a custom markdown-inspired format into HTML with support for inline math, embedded images, and live reload

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages