jsx-to-md

A tool that supports writing Markdown through JSX

English | 简体中文

Table of Contents

Vision
Features
Live Demo
Principle
Help Document
License

Vision

To make it easy and pleasant to write Markdown through JSX 😄💪🏻

Features

• Provides the basic component for rendering and generating Markdown syntax content
• Real-time rendering and generation
• Support Native HTML
• Support rendering multiple documents simultaneously
• Support generate table of contents
• Support asynchronous rendering

Live Demo

• Open in CodeSandbox
• 

Principle

The library is mainly composed of two parts

• Command Line Tools
• Function API

Command Line Tools：Parse configuration files, execute render logic, and finally generate Markdown files

Function API：Provides basic components and render functions of benchmarking Markdown syntax

• Basic components：Basic components for replacing Markdown syntax
• Render function：Render the content written by JSX and return the generated character content

So Command Line Tools and Function API are better used together

Help Document

• Quick Start
• Command Line
• API
• Changelog

License

MIT

Copyright (c) 2022-present Eyelly Wu