Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
thequilo authored Mar 17, 2022
1 parent 8dd7b4c commit 1e65df8
Showing 1 changed file with 11 additions and 2 deletions.
13 changes: 11 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,15 @@

This is a quick write-up of a possible way to render tikz graphics in Obsidian.

:warning: This is an experimental plugin! Things may change and break at any time!
:warning: This is an experimental plugin! Things may change and break at any time! I am not an experienced TypeScript, HTML or CSS programmer! So, no guarantees that anything will work!

![tikz_obsidian_logo](https://user-images.githubusercontent.com/25043715/158750976-109bea4e-ce28-4922-a066-2e184c4c950c.gif)

## Usage

Any code block that has the word combination `tikz render` in the language line will be rendered in preview mode.
This is because the language for syntax highlighting is determined by the first word, so that `latex tikz render` performs latex syntax highlighting.
You can then specify either `side-by-side`, which will render code and image side-by-side (as shown in the demo gif), or `image-only`, which will render only the image.

## Installation

Expand Down Expand Up @@ -33,7 +38,7 @@ Go to the settings of the tikz render plugin and check if the render command is

- Render source code blocks marked with `tikz render` in preview mode

## TODO / Nice to have in the future
### TODO / Nice to have in the future

- Support tikz libraries and global custom styles
- Side-by-side rendering in live-preview to see the image while typing (integration with CodeMirror?)
Expand All @@ -42,3 +47,7 @@ Go to the settings of the tikz render plugin and check if the render command is
- Better error / log messages when build fails
- Test on Windows and Mac
- `tikz style` (or similar) code blocks to define file-local styles

## Contributing

If you want to contribute, feel free to open issues or pull requrests.

0 comments on commit 1e65df8

Please sign in to comment.