Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/arvinxx/lobe-plugin-tikzjax

Convert LaTeX TikZ code into SVG images for crisp, scalable mathematical diagrams and visualizations.
https://github.com/arvinxx/lobe-plugin-tikzjax

Last synced: about 1 month ago
JSON representation

Convert LaTeX TikZ code into SVG images for crisp, scalable mathematical diagrams and visualizations.

Awesome Lists containing this project

README

        



TikZJax SVG Renderer
LobeChat Plugin

Convert LaTeX TikZ code into SVG images for crisp, scalable mathematical diagrams and visualizations.

[![][๐Ÿคฏ-๐Ÿงฉ-lobehub-shield]][๐Ÿคฏ-๐Ÿงฉ-lobehub-link]
[![][github-release-shield]][github-release-link]
[![][github-releasedate-shield]][github-releasedate-link]
[![][github-action-test-shield]][github-action-test-link]
[![][github-action-release-shield]][github-action-release-link]

[![][github-contributors-shield]][github-contributors-link]
[![][github-forks-shield]][github-forks-link]
[![][github-stars-shield]][github-stars-link]
[![][github-issues-shield]][github-issues-link]
[![][github-license-shield]][github-license-link]

[Changelog](./CHANGELOG.md) ยท [Report Bug][github-issues-link] ยท [Request Feature][github-issues-link]

![](https://raw.githubusercontent.com/andreasbm/readme/master/assets/lines/rainbow.png)

Table of contents

#### TOC

- [๐ŸŒŸ Features](#-features)
- [๐Ÿคฏ Usage](#-usage)
- [โŒจ๏ธ Local Development](#๏ธ-local-development)
- [๐Ÿค Contributing](#-contributing)
- [๐Ÿ”— Links](#-links)

####

## ๐ŸŒŸ Features

- [x] ๐Ÿงฎ **LaTeX TikZ to SVG**: Easily convert LaTeX TikZ code into high-quality SVG images.
- [x] ๐Ÿ–ผ๏ธ **Vector Graphics**: Generate crisp and scalable vector graphics suitable for mathematical diagrams and visualizations.
- [x] ๐Ÿ”Œ **LobeChat Integration**: Seamlessly integrates with LobeChat to enhance chat experiences with visual content.
- [x] ๐Ÿš€ **Quick and Responsive**: Efficient rendering process ensures quick responses and smooth interaction.

[![][back-to-top]](#readme-top)

## ๐Ÿคฏ 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.

> [!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](#).

[![][back-to-top]](#readme-top)

## โŒจ๏ธ Local Development

For local development, clone the repository and follow the instructions:

```bash
$ git clone https://github.com/arvinxx/lobe-plugin-tikzjax.git
$ cd tikzjax-svg-renderer
$ npm install
$ npm run dev
```

[![][back-to-top]](#readme-top)

## ๐Ÿค 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.

[![][pr-welcome-shield]][pr-welcome-link]

[![][back-to-top]](#readme-top)

## ๐Ÿ”— Links

- **[๐Ÿค– Lobe Chat](https://github.com/lobehub/lobe-chat)** - An open-source, extensible chatbot framework.
- **[๐Ÿงฉ TikZJax SVG Renderer](https://github.com/arvinxx/lobe-plugin-tikzjax)** - The official repository for the TikZJax SVG Renderer plugin.

[![][back-to-top]](#readme-top)

---

#### ๐Ÿ“ License

Copyright ยฉ 2023 [LobeHub][profile-url].

This project is [MIT](./LICENSE) licensed.

[๐Ÿคฏ-๐Ÿงฉ-lobehub-link]: https://github.com/lobehub/lobe-chat-plugins
[๐Ÿคฏ-๐Ÿงฉ-lobehub-shield]: https://img.shields.io/badge/%F0%9F%A4%AF%20%26%20%F0%9F%A7%A9%20LobeHub-Plugin-95f3d9?labelColor=black&style=flat-square
[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square
[github-release-shield]: https://img.shields.io/github/v/release/arvinxx/lobe-plugin-tikzjax?color=369eff&labelColor=black&logo=github&style=flat-square
[github-release-link]: https://github.com/arvinxx/lobe-plugin-tikzjax/releases
[github-releasedate-shield]: https://img.shields.io/github/release-date/arvinxx/lobe-plugin-tikzjax?labelColor=black&style=flat-square
[github-releasedate-link]: https://github.com/arvinxx/lobe-plugin-tikzjax/releases
[github-action-test-shield]: https://img.shields.io/github/actions/workflow/status/arvinxx/lobe-plugin-tikzjax/test.yml?label=test&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
[github-action-test-link]: https://github.com/arvinxx/lobe-plugin-tikzjax/actions/workflows/test.yml
[github-action-release-shield]: https://img.shields.io/github/actions/workflow/status/arvinxx/lobe-plugin-tikzjax/release.yml?label=release&labelColor=black&logo=githubactions&logoColor=white&style=flat-square
[github-action-release-link]: https://github.com/arvinxx/lobe-plugin-tikzjax/actions/workflows/release.yml
[github-contributors-shield]: https://img.shields.io/github/contributors/arvinxx/lobe-plugin-tikzjax?color=c4f042&labelColor=black&style=flat-square
[github-contributors-link]: https://github.com/arvinxx/lobe-plugin-tikzjax/graphs/contributors
[github-forks-shield]: https://img.shields.io/github/forks/arvinxx/lobe-plugin-tikzjax?color=8ae8ff&labelColor=black&style=flat-square
[github-forks-link]: https://github.com/arvinxx/lobe-plugin-tikzjax/network/members
[github-stars-shield]: https://img.shields.io/github/stars/arvinxx/lobe-plugin-tikzjax?color=ffcb47&labelColor=black&style=flat-square
[github-stars-link]: https://github.com/arvinxx/lobe-plugin-tikzjax/network/stargazers
[github-issues-shield]: https://img.shields.io/github/issues/arvinxx/lobe-plugin-tikzjax?color=ff80eb&labelColor=black&style=flat-square
[github-issues-link]: https://github.com/arvinxx/lobe-plugin-tikzjax/issues
[github-license-shield]: https://img.shields.io/github/license/arvinxx/lobe-plugin-tikzjax?color=white&labelColor=black&style=flat-square
[github-license-link]: https://github.com/arvinxx/lobe-plugin-tikzjax/blob/main/LICENSE
[pr-welcome-shield]: https://img.shields.io/badge/%F0%9F%A4%AF%20PR%20WELCOME-%E2%86%92-ffcb47?labelColor=black&style=for-the-badge
[pr-welcome-link]: https://github.com/arvinxx/lobe-plugin-tikzjax/pulls
[profile-url]: https://github.com/lobehub