Skip to content

Commit 12f603b

Browse files
authored
Update readme (#64)
* Update readme Add Emojis to make it more eye-catchy! Fix typo Add some additional info about using the plugin * Small changes to readme
1 parent 2a69384 commit 12f603b

1 file changed

Lines changed: 57 additions & 11 deletions

File tree

README.md

Lines changed: 57 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,16 @@
22

33
A plugin for displaying mathematical graphs in obsidian.md.
44

5-
> _Remember to star this plugin on [Github](https://github.com/leonhma/obsidian-functionplot) if you like it._
5+
> _Remember to star this plugin on [Github](https://github.com/leonhma/obsidian-functionplot) if you like it!_
66
77
_This file only contains basic instructions to get you to using this plugin quickly. If you want a more detailed documentation, take a look at the [wiki](https://github.com/leonhma/obsidian-functionplot/wiki)._
88

9-
## How to use
9+
---
1010

11+
# 🔮 How to use
12+
### With Command
1113
Since version `1.1.0` you can create plots via a handy GUI with live-preview functionality.
12-
13-
1. Open the command pallete and select `Obsidian Functionplot: Plot a Function`
14+
1. Open the command palette and select `Obsidian Functionplot: Plot a Function`
1415

1516
2. Adjust the plot to your liking.
1617

@@ -19,22 +20,67 @@ Since version `1.1.0` you can create plots via a handy GUI with live-preview fun
1920

2021
3. This will create a coordinate system with bounds `-10 < x < 10, -10 < y < 10` and plot the functions f and g. If you havent disabled it, you can even drag and zoom the graph.
2122

22-
![Graph image](./images/plot/light.png#gh-light-mode-only)
23-
![Graph image](./images/plot/dark.png#gh-dark-mode-only)
24-
25-
## Questions
23+
<!-- ![Graph image](./images/plot/light.png#gh-light-mode-only)
24+
![Graph image](./images/plot/dark.png#gh-dark-mode-only) -->
25+
26+
### With `functionplot` Block
27+
````
28+
```functionplot
29+
---
30+
title: string
31+
xLabel: string
32+
yLabel: string
33+
bounds: array[min x, max x, min y, max y]
34+
disableZoom: boolean
35+
grid: boolean
36+
---
37+
<name>(variable)=<expression>
38+
```
39+
````
40+
Example:
41+
````
42+
```functionplot
43+
---
44+
title: The random graph
45+
xLabel: Time
46+
yLabel: Cost
47+
bounds: [0, 10, 0, 50]
48+
disbaleZoom: 1
49+
grid: true
50+
---
51+
g(x)=x^PI
52+
f(x)=E+log(x)*2
53+
```
54+
````
55+
56+
## 🧮 Supported Math
57+
To see the complete list of supported math functions, please check the [wiki](https://github.com/leonhma/obsidian-functionplot/wiki).
58+
59+
## ⚙ Plugin Settings
60+
Since version `1.2.0` there's a dedicated settings page for this plugin. Here you can adjust things like font sizes for the text elements of the plot, line widths and various colors. To access this page, head to the obsidian settings and scroll down the list to 'Community Plugins > Obsidian Functionplot'.
61+
62+
![Settings Page](https://github.com/leonhma/obsidian-functionplot/blob/master/images/settings/dark.png)
63+
64+
> **Note**
65+
> For changes to be applied, Obsidian needs to "re-render" the chart. You can either restart Obsidian, or switch between view modes (eg. Reading mode > Edit mode > Reading mode).
66+
67+
68+
69+
---
70+
71+
## ❓ Questions
2672

2773
If you have any questions about the usage of the plugin, take a look at the [wiki](https://github.com/leonhma/obsidian-functionplot/wiki) or post a question in the [discussions](https://github.com/leonhma/obsidian-functionplot/discussions).
2874

29-
## Bugs and Errors
75+
## 🐞 Bugs and Errors
3076

3177
If you encounter any errors while using this plugin, please report them to us. To do so, click [this link](https://github.com/leonhma/obsidian-functionplot/issues/new?assignees=leonhma&labels=bug&template=BUG_REPORT.yml), fill out the form as best as you can and click `Submit new issue`. These issues are publically viewable, so please don't submit any personal information.
3278

33-
## Contributing
79+
## 🤝 Contributing
3480

3581
Contributions are always welcome! Be it submitting issues, editing the wiki or creating a pull request, contributions by people like you help keep the project evolving. Please adhere to the [contributing guidelines](CONTRIBUTING.md).
3682

37-
## Attribution
83+
## ©️ Attribution
3884

3985
This plugin is based on / uses:
4086

0 commit comments

Comments
 (0)