Obsidian Stats logoObsidian Stats

Goban Viewer

by Davide Aversa
5
4
3
2
1
New Plugin
Install Code

Description

This plugin has not been manually reviewed by Obsidian staff. Render Go/Baduk positions diagrams in note preview.

Reviews

No reviews yet.

Stats

stars
downloads
0
forks
0
days
NaN
days
NaN
days
0
total PRs
0
open PRs
0
closed PRs
0
merged PRs
0
total issues
0
open issues
0
closed issues
0
commits

Latest Version

Invalid date

Changelog

See all version on GitHub

README file from

Github

Goban Viewer

Goban Viewer renders Go/Baduk/Weiqi diagrams in Obsidian using Sensei's Library diagram syntax.

Write a diagram inside a fenced goban code block and the plugin will render it as an SVG goban directly in your note.

Features

  • Render Sensei's Library-style Go diagrams in Obsidian notes.
  • Supports fenced code blocks using the goban language.
  • Outputs lightweight SVG diagrams.
  • Works on desktop and mobile Obsidian.

The plugin is currently very experimental and offers limited customization options. But they will come in the future. :)

Installation

From Obsidian Community Plugins

  1. Open Settings → Community plugins in Obsidian.
  2. Disable Restricted mode, if needed.
  3. Click Browse.
  4. Search for Goban Viewer.
  5. Install and enable the plugin.

Manual installation

  1. Download main.js, manifest.json, and styles.css from the latest release.
  2. Create the folder .obsidian/plugins/goban-viewer/ inside your vault, if it does not already exist.
  3. Copy the downloaded files into that folder.
  4. Reload Obsidian.
  5. Enable Goban Viewer from Settings → Community plugins.

Usage

Create a fenced code block with the goban language and write the board position using Sensei's Library diagram notation.

```goban
$$c Links in diagrams - examples
$$  --------------
$$ | . . . . 1 . .
$$ | . C . . . . .
$$ | 2 . . X O 4 .
$$ | . . X O . . .
$$ | . . X O . . .
$$ | 3 . a . . C .
$$ | . . . . . . .
$$ [2|NadareJoseki]
$$ [a|http://gtl.xmp.net/members/info?p_key=349&pseudo=dada]
$$ [C|#1]
```

You should get something like this:

For the full diagram syntax, see How Diagrams Work on Sensei's Library.

Limitations

Goban Viewer uses a renderer derived from an older Sensei's Library diagram conversion script. Most common diagrams should work, but some less common markup may be incomplete or behave differently from Sensei's Library.

If you find a diagram that does not render correctly, please open an issue with the original diagram text and the expected output.

Development

Install dependencies:

npm install

Run a development build with watch mode:

npm run dev

Create a production build:

npm run build

The Obsidian plugin entry point is generated as main.js in the repository root.

License

This project is licensed under the GNU General Public License v3.0. See LICENSE for details.

Sponsors