Awesome
<a name="readme-top"></a>
<div align="center"> <img height="120" src="https://registry.npmmirror.com/@lobehub/assets-emoji/1.3.0/files/assets/puzzle-piece.webp"> <img height="120" src="https://gw.alipayobjects.com/zos/kitchen/qJ3l3EPsdW/split.svg"> <img height="120" src="https://registry.npmmirror.com/@lobehub/assets-emoji-anim/1.0.0/files/assets/triangular-ruler.webp"> <h1>TikZJax SVG Renderer<br/><sup>LobeChat Plugin</sup></h1>Convert LaTeX TikZ code into SVG images for crisp, scalable mathematical diagrams and visualizations.
Changelog ยท Report Bug ยท Request Feature
</div> <details> <summary><kbd>Table of contents</kbd></summary>TOC
</details>๐ Features
- ๐งฎ LaTeX TikZ to SVG: Easily convert LaTeX TikZ code into high-quality SVG images.
- ๐ผ๏ธ Vector Graphics: Generate crisp and scalable vector graphics suitable for mathematical diagrams and visualizations.
- ๐ LobeChat Integration: Seamlessly integrates with LobeChat to enhance chat experiences with visual content.
- ๐ Quick and Responsive: Efficient rendering process ensures quick responses and smooth interaction.
๐คฏ Usage
[!IMPORTANT]
To use the TikZJax SVG Renderer plugin, send a POST request to the plugin endpoint with your LaTeX TikZ code as the input. The plugin will return the SVG image encoded in base64.
<div align="right"> </div>[!Note]
Make sure your input is a valid LaTeX TikZ code snippet to ensure proper rendering of the SVG image. For more details and examples, refer to the ๐ TikZJax SVG Renderer Usage Guide.
โจ๏ธ Local Development
For local development, clone the repository and follow the instructions:
$ git clone https://github.com/arvinxx/lobe-plugin-tikzjax.git
$ cd tikzjax-svg-renderer
$ npm install
$ npm run dev
<div align="right">
</div>
๐ค Contributing
We welcome contributions to the TikZJax SVG Renderer plugin. If you have suggestions or improvements, feel free to submit a pull request or open an issue.
<div align="right"> </div>๐ Links
- ๐ค Lobe Chat - An open-source, extensible chatbot framework.
- ๐งฉ TikZJax SVG Renderer - The official repository for the TikZJax SVG Renderer plugin.
๐ License
Copyright ยฉ 2023 LobeHub. <br /> This project is MIT licensed.
<!-- LINK GROUP -->