Could you please add a simple example to demonstrate how to use this plugin?

[722tzz]

I'm a new user of Obsitain, I have read the readme, but I still cannot comprehend how to use it.
So, could you please to add a simple example to demonstrate how to use this plugin?

[RyotaUshio]

@zhaoshenzhai The current README was written basically before Obsidian v1.4 comes out, which has introduced Properties (the same thing as YAML front matter/metadata but looks fancy). So we might have to update our documentation to make it easier to understand for new users.

Also, the new properties do not support multi-level YAML: https://forum.obsidian.md/t/properties-support-multi-level-yaml-nested-attributes/63826
which forces users to switch to "source" mode when setting a block mathlink. Maybe we should add a remark on that, too.

(Or it might be helpful to add a new syntax like

mathLink-blocks: ["blockID", "$mathlink goes here$"], ...

)

[LynetteCullens]

At the moment, My setup is as follows:

1. Use Glossary Plugin to maintain auto links to the Title of my equation variables and [https://github.com/RyotaUshio/obsidian-rendered-block-link-suggestions](Render BlockLink Suggestions) so that I can view my links.

2. Use the Metadata Menu Plugin to quickly add frontmatter to all entries located in my Glossary folder.
   When creating a new file, it ends up looking like this:
   --- fileClass: Glossary, Glossary mathLink: aliases: mathLink-blocks: ---
   

3. Under MathLinks Settings, Remove the "^" under "Edit prefix for block links, and then toggle it off.

4. Create an entry into the glossary folder Like this:
   

With mathLink-blocks entries done via the MetaData Menu interface.

6. I did all of that and more to create a glossary entry that explains this:
   

With Linkage Like this. Now I don't have to remember words, just symbols.