Project Name

md-html

中文

Project Overview

md-html is a tool for rendering Markdown files to HTML, using GitHub-style Markdown and syntax highlighting. It also integrates marked-alert and marked-katex-extension plugins for handling alerts and mathematical formulas.

Features

• Custom Templates: Supports custom HTML templates.
• Syntax Highlighting: Uses highlight.js for syntax highlighting.
• GitHub-style Markdown: Supports GitHub-style Markdown.
• Alerts: Integrates marked-alert plugin for Markdown alerts.
• Mathematical Formulas: Integrates marked-katex-extension plugin for KaTeX mathematical formula rendering.

Installation

Install using npm:

1npm install @karinjs/md-html

Usage

Basic Usage

Here is a basic usage example:

1import { markdown } from '@karinjs/md-html'
2
3const markdownText = '# Hello, Markdown!'
4const html = markdown(markdownText, {})
5console.log(html)

Configuration Options

You can pass a configuration object to customize the rendering behavior:

1import { markdown } from '@karinjs/md-html'
2
3const options = {
4  template: 'path/to/custom/template.html',
5  katex: { throwOnError: false },
6  gitcss: 'github-markdown-dark.css', // Use GitHub-style dark theme
7  highlight: 'atom-one-dark', // Use Atom One Dark syntax highlighting theme
8}
9
10const markdownText = '# Hello, Markdown!'
11const html = markdown(markdownText, options)
12console.log(html)

Use in Karin

1import karin, { render, segment } from 'node-karin'
2import { markdown } from '@karinjs/md-html'
3import fs from 'node:fs'
4
5export const hello = karin.command(/^#test$/, async (e) => {
6  // define plugin path
7  const pluginPath = process.cwd() + '/plugins/karin-plugin-basic'
8  // read the markdown file
9  const markdownText = fs.readFileSync(`${pluginPath}/README.md`, 'utf8')
10  // generate html text
11  const html = markdown(markdownText, {})
12  // write to html file
13  fs.writeFileSync(`${pluginPath}/README.html`, html, 'utf8')
14  // render picture
15  const image = await render.renderHtml(`${pluginPath}/README.html`)
16  // send pictures
17  e.reply(segment.image(image))
18  return true
19})
20

Configuration Options

The Options interface defines configurable options:

• template (optional): Path to a custom HTML template file or template string.
• katex (optional): KaTeX configuration options. Refer to the KaTeX documentation for details.
• gitcss (optional): GitHub Markdown style theme. Possible values are in the GithubMarkdownThemes enum.
• highlight (optional): Syntax highlighting theme. Possible values are in the HighlightJsThemes enum.

Development and Build

Project Structure

@karinjs/md-html/
├── src/
│   ├── index.ts
│   ├── styles.ts
├── package.json
├── README.md
└── ...

Scripts

• npm run build: Build the project.

Contributions

Feel free to submit issues and pull requests to contribute to the project.

License

This project is licensed under the MIT License. See the LICENSE file for details.