## md-cli-converter
A simple CLI tool that lets you generate static HTML files from Markdown. Supports custom styles (`.css`) and custom templates (`.ejs`)
## To Start
Install globally from [npm](https://www.npmjs.com/package/md-cli-converter):
``` bash
npm install -g md-cli-converter
```
Default use - convert a Markdown file (.md) into an HTML file:
``` bash
md-to-html notes.md --output site/
```
This will convert `notes.md` to `notes.html` and save the output in the `site/` folder and automatically apply the default `styles.css`
```
site/
│── notes.html
│── styles.css
```
## Custom Styling (`--css`) - You can use your own CSS file instead of the default `styles.css`:
``` bash
md-to-html notes.md --output site/ --css styles/custom.css
```
Example Directory:
```
my-project/
│── notes.md
│── styles/
│ ├── custom.css
│── site/
│ ├── notes.html
│ ├── custom.css // Copied here automatically
```
## Custom Templates (`--template`) - For a custom HTML structure define your own EJS template:
``` bash
md-to-html notes.md --output site/ --template templates/my-template.ejs
```
Example Directory:
```
my-project/
│── notes.md
│── templates/
│ ├── my-template.ejs
│── site/
│ ├── notes.html // Uses my-template.ejs
```
Example Markdown File (`notes.md`)
``` Markdown
title: My First Blog Post
author: First Last
date: 2025-02-10
---
# Welcome to My Blog
This is an example Markdown file that will be converted into HTML
## Features:
- Converts Markdown to HTML
- Supports custom styles
- Works with custom templates
```
Generated HTML (`notes.html`)
``` HTML
My First Blog Post
My First Blog Post
By Jane Doe | 2025-02-10
Welcome to My Blog
This is an example Markdownfile that will be converted into HTML
Features:
Converts Markdown to HTML
Supports custon styles
Works with custon templates
```
## Command Reference
Converts a Markdown file to HTML
``` bash
md-to-html
```
Specifies the output directory
``` bash
--output
```
Applies a custom CSS file
``` bash
--css
```
Uses a custom EJS template
``` bash
--template
```