mth-cli is a command-line tool that converts Markdown files to HTML. It supports custom HTML templates, batch conversion of files, and a watch mode to automatically update HTML when Markdown files are modified.
- Convert single or multiple Markdown files to HTML.
- Use custom HTML templates.
- Watch mode for real-time file conversion on changes.
- Batch conversion of all Markdown files in a directory.
- Custom CSS support.
First, install the package globally using npm:
npm install -g mth-live-cliThis will install the mth-cli command globally on your system.
Create a mthclirc.json file in the root of your project.
To simplify the command line usage, you can use the configuration file instead of using flags:
{
"watch": true,
"single": false,
"template":"path/to/template.html",
"css": [
"./styles.css"
],
"live": true,
"port": 8080
}The CLI requires atleast two argumnents: inputDir and outputDir.
mth-cli <inputDir> <outputDir> [options]- : The directory containing Markdown files or a single Markdown file.
- : The directory where the converted HTML files will be saved.
| Option | Alias | Description | Default |
|---|---|---|---|
--single |
-s |
Convert a single Markdown file | false |
--template |
-t |
Path to a custom HTML template | src/template/default.html |
--css |
-c |
Path to a custom CSS file | "" |
--watch |
-w |
Watch the input directory for changes | false |
--live |
-l |
Enable live server functionality | false |
--port |
-p |
Port number for the live server | 8080 |
--help |
Show help | ||
--version |
Show version number |
Convert a single file named README.md into HTML:
mth-cli -s README.md output/This will create output/README.html.
Convert all .md files in the docs directory to HTML files in the output directory:
mth-cli docs/ output/This will convert all the Markdown files in docs and output the corresponding .html files to the output/ directory.
To specify a custom template, use the --template option. For example, if you have a custom template file template.html, run:
mth-cli docs/ output/ --template template.htmlNOTE: In your template, use {{title}}, {{content}} and {{script}} , as a placeholders for the converted Markdown content:
<html>
<head>
<title>{{title}}</title>
</head>
<body>
<h1>Markdown Output</h1>
<div id="content">{{content}}</div>
<script>{{script}}</script>
</body>
</html>To automatically convert files when changes are detected, use the --watch option:
mth-cli docs/ output/ --watchAny time a Markdown file in the docs/ directory is modified, the corresponding HTML file will be regenerated in the output/ directory.
To start a live server for real-time viewing, use the --live and --port (default is 8080) options:
mth-cli docs/ output/ --live --watchThis will start a live server at http://localhost:8080 where you can view the converted HTML files. The page will automatically refresh when changes are detected.
NOTE: The live server will only work if the --watch option is also set.
You can enhance the appearance of your generated HTML files by including CSS stylesheets. To do this, simply provide the paths to your CSS files when running the CLI tool.
mth-cli --input ./path/to/markdown --output ./path/to/html --css ./path/to/styles.cssReplace your-cli-tool with the actual name of your CLI tool.
- input specifies the path to your Markdown files.
- output specifies the directory where you want the generated HTML files to be saved.
- css allows you to specify one or more CSS files to include in the generated HTML.
You can also provide multiple CSS files like this in the configuration file:
{
"css": ["tmp/style-1.css", "tmp/style-2.css", "tmp/dir/style-3.css"]
}This will include both styles1.css and styles2.css in your HTML files. Also this works only the current directories, i.e. tmp and tmp/dir will have different CSS files.
Run the following command to see all available options:
mth-cli --helpIf you want to work on the tool locally:
git clone https://github.com/satyammattoo/mth-cli.gitnpm installnpm linknpm run devmth-cli <inputDir> <outputDir> [options]Feel free to open issues or submit pull requests for bug fixes, improvements, or new features. Contributions are welcome!
Satyam Mattoo