ryojerryyu_obsidian-jessiecode/README.md

58 lines
1.4 KiB
Markdown
Raw Normal View History

2025-10-08 17:53:36 +00:00
# Obsidian JessieCode
Plugin of [Obsidian](https://obsidian.md/) that creates interactive graphs described by [JessieCode](https://github.com/jsxgraph/JessieCode).
2025-10-08 17:53:36 +00:00
## What is JessieCode?
JessieCode is a script language for [JSXGraph](https://jsxgraph.org/wp/index.html), for describing interactive graphs.
```jessiecode
A = point(1, 0);
B = point(-1, 0);
C = point(0.2, 1.5);
L_AB = line(A, B);
L_AC = line(A, C);
K_ABC = circle(A, B, C);
```
## How to use
2025-10-08 17:53:36 +00:00
To create a graph create a code block with the language set to jessiecode. You can also use YAML frontmatter to set the width and height of the graph, or other attributes defined in the JSXGraph documentation.
````markdown
2025-10-08 17:53:36 +00:00
```jessiecode
---
width: 500
height: 400
boundingBox: [-5, 4, 5, -4]
2025-10-08 17:53:36 +00:00
---
A = point(3, -2);
B = point(-3, -1);
C = point(1, 3);
line(A, B);
segment(A, C);
circle(A, B, C);
2025-10-08 17:53:36 +00:00
```
````
And it will be rendered as:
![Example graph](./images/00-how-to-use.png)
2025-10-08 17:53:36 +00:00
## Bugs
If you find any bugs with this plugin please create a new issue so that they can be resolved.
## Contributing
If you want to contribute please create an issue or pull request.
## Attribution
This plugin uses
2025-10-08 17:53:36 +00:00
- [JSXGraph](https://jsxgraph.org/wp/index.html)
- [JessieCode](https://github.com/jsxgraph/JessieCode)
And also thanks to [obsidian-graphs](https://github.com/DylanHojnoski/obsidian-graphs) plugin for the inspiration.