2022-12-04 04:43:33 +00:00
# Meld Build - An Obsidian Plugin
2022-11-22 11:31:32 +00:00
2023-01-06 05:15:36 +00:00
Write and execute (sandboxed) JavaScript to render templates, query DataView and create dynamic notes.
2023-01-03 04:42:02 +00:00
2023-01-06 04:29:58 +00:00
Basically, turn a note into a small, simple, runnable thing.
## Quick Start
- Install and enable the plugin
- Paste the Markdown below into a new note.
- If you are in Reading or Live Preview modes, click the 'Hi' button. If you are in Source mode, choose `Meld Build: Run` from the command pallette.
````md
```meld-build-toolbar
run = Hi
```
```js meld-build
const ans = await $.ui.ask('What should I call you?');
await $.ui.message( `From this day forth you shall be known as ${ans}` );
```
````
2023-01-06 08:47:23 +00:00
## Documentation
2022-11-22 11:31:32 +00:00
2023-01-03 04:42:02 +00:00
- [User Guide ](/docs/user-guide.md )
2023-01-06 00:48:56 +00:00
- [API ](/docs/api.md )
2022-11-22 11:31:32 +00:00
2023-01-03 04:27:56 +00:00
### Examples
2022-11-22 11:31:32 +00:00
2023-01-06 00:48:56 +00:00
- [Guess The Number Game ](/docs/examples/guess-the-number.md )
- [Simple Invoice Builder ](/docs/examples/invoice-builder.md )
2022-11-22 11:31:32 +00:00
2023-01-06 04:34:01 +00:00
## Known Issues
- If you quickly try to run a note just after some changes, there's a chance that the Obsidian cache hasn't been updated yet. The workaround for now is to wait a second or two before running a changed note.
2023-01-03 04:27:56 +00:00
## Manually installing the plugin
2022-11-22 11:31:32 +00:00
2023-01-03 04:27:56 +00:00
- Copy over `main.js` , `styles.css` , `manifest.json` to your vault `VaultFolder/.obsidian/plugins/meld-build/` .
