carta/packages/plugin-tikz
2024-05-11 02:20:51 +02:00
..
public add tikz plugin(wip) 2023-07-16 18:17:20 +02:00
src fix: rename package name 2024-05-11 02:20:51 +02:00
.gitignore add tikz plugin(wip) 2023-07-16 18:17:20 +02:00
package.json fix: rename package name 2024-05-11 02:20:51 +02:00
README.md fix: rename package name 2024-05-11 02:20:51 +02:00
tsconfig.json fix: remove typescript project references 2023-11-14 18:37:19 +01:00
tsconfig.node.json add tikz plugin(wip) 2023-07-16 18:17:20 +02:00
vite.config.ts don't externalize md5 but move it to dev deps 2023-07-23 19:03:09 +02:00

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, MarkdownEditor } from '@thetadev/carta-md';
	import { tikz } from '@cartamd/plugin-tikz';

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

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

<MarkdownEditor {carta} />

Documentation

Checkout the docs for examples, options and more.