A SiYuan plugin for freehand drawing, based on js-draw.
Some checks failed
Create Release on Tag Push / build (push) Has been cancelled
|
||
---|---|---|
.github/workflows | ||
asset | ||
public | ||
scripts | ||
src | ||
.gitignore | ||
CHANGELOG.md | ||
icon.png | ||
LICENSE | ||
package.json | ||
plugin.json | ||
preview.png | ||
README.md | ||
svelte.config.js | ||
tsconfig.json | ||
tsconfig.node.json | ||
vite.config.ts | ||
vite.config.ts.timestamp-1743541342564-d66840ad6dd8b.mjs | ||
yaml-plugin.js |
SiYuan js-draw Plugin
This plugin allows you to embed js-draw whiteboards anywhere in your SiYuan documents.
Usage instructions
- Install the plugin from the marketplace. You can find it by searching for
js-draw
. - To add a new drawing to your document:
- Type
/Insert Drawing
in your document, and select the correct menu entry - The whiteboard editor will open in a new tab. Draw as you like, then click the Save button and close the tab.
- Type
- To edit the image later:
- Right-click on the image (or click the three dots on mobile), select "Plugin" > "Edit with js-draw" in the menu
- The editor tab will open, edit your file as you like, then click the Save button and close the tab.
Planned features
Check out the Projects tab!
Contributing
Contributions are always welcome! Right now, I'm working on the core functionality and fixing bugs.
After that is done, I will need help with the internationalization, as, unfortunately, I don't speak Chinese.
Please contact me if you'd like to help!
Thanks to
This project couldn't have been possible without (in no particular order):
- The SiYuan project
- js-draw
- SiYuan plugin sample with vite and svelte
- siyuan-drawio-plugin and siyuan-plugin-whiteboard for inspiration and bits of code
Make sure you check them out and support them as well!
License
The original plugin framework is developed by SiYuan 思源笔记 and licensed under the MIT license.
All changes made by me are copyright MassiveBox 2025, and licensed under the MIT license.