carta/packages/plugin-tikz/README.md

Carta TikZ Plugin

This plugin adds support for PGF/TikZ illustrations thanks to TikzJax. It uses the code generated for the Obsidian-TikZ plugin. Install it using:

npm i @cartamd/plugin-tikz

Important Notes

1. This plugin requires the import of a heavy library (~7Mb), which is dynamically imported at runtime;
2. Generated images are not ssr compatible, as they are rendered in the browser;
3. You need to update your sanitizer to allow the specific tag: <div type="text/tikz">.

Setup

<script lang="ts">
	import { Carta, CartaEditor } from 'carta-md';
	import { tikz } from '@cartamd/plugin-tikz';

	import '@cartamd/plugin-tikz/fonts.css';

	const carta = new Carta({
		extensions: [tikz()]
	});
</script>

<CartaEditor {carta} />

Documentation

Checkout the docs for examples, options and more.