# ts-markdown-parser
`ts-markdown-parser` is a TypeScript-based library for converting Markdown to HTML with built-in syntax highlighting for various programming languages. Currently, it supports HTML, JavaScript, TypeScript, SQL, Python, and others for code highlighting, with plans to expand to more languages in the future.
## Installation
To install the package, run:
```bash
npm install ts-markdown-parser
```
## Usage
Here's a basic example of how to use `ts-markdown-parser` to convert Markdown to HTML:
```javascript
const { markdownToHtml } = require("ts-markdown-parser");
// Your Markdown content
const markdown = `
# Sample Heading
\`\`\`javascript
console.log("Hello, world!");
\`\`\`
## Subheading
Some text.
[Link text](https://example.com)
`;
// Convert Markdown to HTML
const htmlContent = markdownToHtml(markdown);
// Basic HTML template
const htmlTemplate = `
Markdown Test
${htmlContent}
`;
// Output HTML to a file or use as needed
```
### TypeScript Usage
Here's how you might use it in your TypeScript code:
```ts
import * as fs from "fs";
import { markdownToHtml, getMarkdownMetadata } from "ts-markdown-parser";
// ...
const file = "/path/to/my-markdown.md";
const markdownString = fs.readFileSync(file, "utf8");
const htmlString: string | undefined = markdownToHtml(markdownString);
if (!htmlString) {
console.error(`Failed to generate HTML from: ${file}.`);
}
const metadata: Record = getMarkdownMetadata(markdownString);
if (!metadata?.title) {
console.error(`Markdown file '${file}' is missing metadata.`);
}
```
### npx Command to Test Code
Use `npx ts-node` to test a TypeScript usage of this package:
```bash
npx ts-node test.ts
```
You can also use `ts-node` like so:
```bash
ts-node test.ts
```
## Metadata Parsing
You can also extract metadata from your Markdown files using YAML front matter.
Here's how to use the `getMarkdownMetadata()` function:
```javascript
const { getMarkdownMetadata } = require("ts-markdown-parser");
// Your Markdown content with YAML front matter
const markdown = `
---
title: "Example Markdown Article for HTML"
author: "ChatGPT"
date: 2024-08-19
keywords: scripting, html, web development, markdown, blog
slug: markdown-article-test-for-html
---
# Sample Heading
Some text.
`;
// Extract metadata
const metadata = getMarkdownMetadata(markdown);
console.log(metadata);
```
The metadata object literal response should look something like this:
```js
{
title: 'Example Markdown Article for HTML',
author: 'ChatGPT',
date: '2024-08-19', // Date formatted as string
keywords: [ 'scripting', 'html', 'web development', 'markdown', 'blog' ],
slug: 'markdown-article-test-for-html'
}
```
### Example YAML Front Matter
YAML front matter is a way to include metadata at the top of your Markdown files. Here's another example:
```yaml
---
title: "Example Markdown Article for HTML"
author: "ChatGPT"
date: 2024-08-19
id: "1234"
keywords: scripting, html, web development, markdown, blog
slug: markdown-article-test-for-html
---
```
### Metadata Extraction Result
Given the YAML front matter above, `getMarkdownMetadata` would return:
```json
{
"title": "Example Markdown Article for HTML",
"author": "ChatGPT",
"date": "2024-08-19", // Date formatted as string
"id": 1234, // String representation of number parsed and casted as number
"keywords": ["scripting", "html", "web development", "markdown", "blog"],
"slug": "markdown-article-test-for-html"
}
```
## Features
- **Markdown Elements Supported:**
- Headers (1-5)
- Ordered and unordered lists
- Bold and italic text
- Inline code and code blocks
- Images (``)
- Links (`[Link text](url)`)
- **Code Highlighting Supported For:**
- HTML
- CSS/SCSS
- JavaScript
- TypeScript
- Python
- Golang
- SQL
- TSX/JSX
- Lua
- **Metadata Parsing:**
- Extract metadata from YAML front matter.
- Handles title, author, date, keywords, slug, and more.
- **Note:** Table/grid support is not yet available.
## Screenshots
When you properly apply styles to the generated `md-*` CSS classes, the final HTML should look something like this:
## Contributing
We welcome suggestions and feedback, but all code contributions require prior permission. Please submit issues or feature requests, and if you would like to contribute code, contact the repository owner for permission.
## License
This project is licensed under the MIT License. Feel free to use the code in your own projects or fork it, but contributions to the repository are managed by the project owner and require permission.