https://github.com/kdheepak/quarto-svgbob

Render svgbob diagrams directly in your quarto documents.
https://github.com/kdheepak/quarto-svgbob

Last synced: 7 months ago
JSON representation

Render svgbob diagrams directly in your quarto documents.

README

# quarto-svgbob

Render [svgbob](https://github.com/ivanceras/svgbob) diagrams directly in your [quarto](quarto.org/)
documents.

## Installing

```bash
quarto add kdheepak/quarto-svgbob
```

This will install the extension under the `_extensions` subdirectory. If you're using version
control, you will want to check in this directory.

## Usage

Here is how you add the filter to a page (it can also be added to a `_quarto.yml` project file with
the same syntax):

```markdown
---
title: "My Document"
filters:
- quarto-svgbob
---
```

And then add the following markdown in your quarto file:

````markdown
```svgbob

.---.
/-o-/--
.-/ / /->
( * \/
'-. \
\ /
'
```
````

Make sure you have `svgbob` installed. `svgbob_cli` must be available in your PATH.

## Example

Here is the source code for a minimal example: [example.qmd](example.qmd).

See this for HTML preview: https://kdheepak.com/quarto-svgbob/

## For PDF output

If the pdf output format is enabled, you can insert svgbob diagrams via `inkscape`:

```markdown
---
title: "My Document"
filters:
- quarto-svgbob
format: pdf
---
```

In that case make sure you have `inkscape` installed and available in your PATH.