https://github.com/billykirk01/md2html
A lightweight tool for creating github flavored HTML documents from markdown. Built using Deno.
https://github.com/billykirk01/md2html
deno markdown-to-html typescript
Last synced: 3 months ago
JSON representation
A lightweight tool for creating github flavored HTML documents from markdown. Built using Deno.
- Host: GitHub
- URL: https://github.com/billykirk01/md2html
- Owner: billykirk01
- Created: 2021-12-01T19:20:48.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-12-11T14:38:25.000Z (over 3 years ago)
- Last Synced: 2024-05-23T00:16:11.683Z (about 1 year ago)
- Topics: deno, markdown-to-html, typescript
- Language: TypeScript
- Homepage:
- Size: 20.5 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# md2html
A lightweight tool for creating github flavored HTML documents from markdown.
Built using Deno.
## ✨ Features
- Simple to use API and CLI
- Github flavored styling
[github-markdown-css](https://github.com/sindresorhus/github-markdown-css)
## 📦 Importing
```typescript
import { markdownToHTML } from "https://deno.land/x/md2html/mod.ts";
```
## 📖 Example Usage
Markdown saved locally
```typescript
const html = await markdownToHTML("./README.md");
```
Markdown from a remote URL
```typescript
const html = await markdownToHTML(
"https://raw.githubusercontent.com/wkirk01/md2html/master/README.md",
);
```
## 🚀 Using the CLI
Install
```shell
deno install -n md2html -A --unstable https://deno.land/x/md2html/cli.ts
```
Usage
```shell
md2html MARKDOWN_LOCATION HTML_SAVE_LOCATION
```
Command line mode
```shell
md2html ./README.md ./index.html
```
Interactive mode
```shell
$ md2html
? Markdown Location (local file or remote url) › ./README.md
? HTML Save Location › ./index.html
```