feat: Update - README.md and version compatibility

This commit is contained in:
land0r 2024-11-14 13:48:05 +01:00
parent 472c717e6e
commit f9d3c25c93
7 changed files with 108 additions and 3 deletions

View file

@ -1,3 +1,4 @@
node_modules
assets
.github
main.js

95
Flowchart Plugin Test.md Normal file
View file

@ -0,0 +1,95 @@
## Demo 1
```flowchart
st=>start: Start:>http://www.google.com[blank]
e=>end:>http://www.google.com
op1=>operation: My Operation
sub1=>subroutine: My Subroutine
cond=>condition: True
or False?:>http://www.google.com
io=>inputoutput: catch something...
para=>parallel: parallel tasks
in=>input: some in
out=>output: some out
st->op1->cond
cond(yes)->io->e
cond(no)->para
para(path1, bottom)->sub1(right)->op1
para(path2, top)->op1
para(path3, right)->in->out->e
```
## Demo 2
```flowchart
st=>start: Start|past:>http://www.google.com[blank]
e=>end: End|future:>http://www.google.com
op1=>operation: My Operation|past
op2=>operation: Stuff|current
sub1=>subroutine: My Subroutine|invalid
cond=>condition: Yes
or No?|approved:>http://www.google.com
c2=>condition: Good idea|rejected
io=>inputoutput: catch something...|future
st->op1(right)->cond
cond(yes, right)->c2
cond(no)->sub1(left)->op1
c2(yes)->io->e
c2(no)->op2->e
```
## Demo 3
```flowchart
st=>start: Improve your
l10n process!
e=>end: Continue to have fun!:>https://youtu.be/YQryHo1iHb8[blank]
op1=>operation: Go to locize.com:>https://locize.com[blank]
sub1=>subroutine: Read the awesomeness
cond(align-next=no)=>condition: Interested to
getting started?
io=>inputoutput: Register:>https://www.locize.app/register[blank]
sub2=>subroutine: Read about improving
your localization workflow
or another source:>https://medium.com/@adrai/8-signs-you-should-improve-your-localization-process-3dc075d53998[blank]
op2=>operation: Login:>https://www.locize.app/login[blank]
cond2=>condition: valid password?
cond3=>condition: reset password?
op3=>operation: send email
sub3=>subroutine: Create a demo project
sub4=>subroutine: Start your real project
io2=>inputoutput: Subscribe
st->op1->sub1->cond
cond(yes)->io->op2->cond2
cond2(no)->cond3
cond3(no,bottom)->op2
cond3(yes)->op3
op3(right)->op2
cond2(yes)->sub3
sub3->sub4->io2->e
cond(no)->sub2(right)->op1
st@>op1({"stroke":"Red"})@>sub1({"stroke":"Red"})@>cond({"stroke":"Red"})@>io({"stroke":"Red"})@>op2({"stroke":"Red"})@>cond2({"stroke":"Red"})@>sub3({"stroke":"Red"})@>sub4({"stroke":"Red"})@>io2({"stroke":"Red"})@>e({"stroke":"Red","stroke-width":6,"arrow-end":"classic-wide-long"})
```
## Demo 4
```flowchart
st=>start: Need something to be translated!:>https://www.localistars.com[blank]
e=>end: Be happy!:>https://youtu.be/e6Ede8hdU8c
cond=>condition: Are you a client
or a translator?
subc=>subroutine: Why should you choose a localistar?:>https://www.localistars.com/for-clients.html
subt=>subroutine: Why should you become a localistar?:>https://www.localistars.com/for-translators.html
op=>operation: Check out how it works!:>https://www.localistars.com/how-it-works.html
io=>inputoutput: Work together with your partner!:>https://www.localistars.app/login
st->cond
cond(no@client)->subc->op->io->e
cond(yes@translator)->subt->op->io->e
```

View file

@ -1,5 +1,10 @@
# Obsidian Flowchart Plugin
![Version](https://img.shields.io/github/v/tag/land0r/obsidian-flowchart-plugin?label=version)
![Build Status](https://github.com/land0r/obsidian-flowchart-plugin/actions/workflows/ci.yml/badge.svg)
![License](https://img.shields.io/github/license/land0r/obsidian-flowchart-plugin)
![GitHub Stars](https://img.shields.io/github/stars/land0r/obsidian-flowchart-plugin?style=social)
This is a custom plugin for rendering flowcharts in Obsidian using **flowchart.js**. It allows users to insert and render flowcharts directly within Obsidian notes using a dedicated code block syntax.
## Features
@ -26,7 +31,9 @@ This is a custom plugin for rendering flowcharts in Obsidian using **flowchart.j
```
````
2. The plugin will render the flowchart according to the configuration specified in the plugin settings.
2. The plugin will render the flowchart according to the configuration specified in the plugin settings. You can check more examples here: [Flowchart Plugin test](./Flowchart%20Plugin%20Test.md).
![Demo](./assets/images/demo.png)
## Plugin Settings
@ -42,6 +49,8 @@ The plugin includes various settings that allow you to customize the appearance
You can access these settings under **Settings** > **Community Plugins** > **Flowchart Plugin**.
![Settings](./assets/images/settings.png)
## Development Guide
### Building the Plugin

BIN
assets/images/demo.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 149 KiB

BIN
assets/images/settings.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 228 KiB

View file

@ -2,7 +2,7 @@
"id": "obsidian-flowchart-plugin",
"name": "Flowchart Plugin",
"version": "1.0.0",
"minAppVersion": "0.15.0",
"minAppVersion": "1.5.0",
"description": "A plugin for rendering flowcharts using flowchart.js",
"author": "land0r",
"authorUrl": "https://github.com/land0r",

View file

@ -1,3 +1,3 @@
{
"1.0.0": "0.15.0"
"1.0.0": "1.5.0"
}