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

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

Last synced: 3 months ago
JSON representation

Render svgbob diagrams directly in your quarto documents.

• Host: GitHub
• URL: https://github.com/kdheepak/quarto-svgbob
• Owner: kdheepak
• License: mit
• Created: 2023-10-13T18:15:53.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-08-27T23:37:16.000Z (5 months ago)
• Last Synced: 2024-08-28T00:48:04.143Z (5 months ago)
• Language: Lua
• Homepage: http://kdheepak.com/quarto-svgbob/
• Size: 351 KB
• Stars: 4
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

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.