https://github.com/meld-cp/obsidian-build

Write and execute (sandboxed) JavaScript to render templates, query DataView and create dynamic notes.
https://github.com/meld-cp/obsidian-build

Last synced: 17 days ago
JSON representation

Write and execute (sandboxed) JavaScript to render templates, query DataView and create dynamic notes.

• Host: GitHub
• URL: https://github.com/meld-cp/obsidian-build
• Owner: meld-cp
• License: mit
• Created: 2023-01-02T05:15:23.000Z (almost 2 years ago)
• Default Branch: master
• Last Pushed: 2024-06-06T07:39:19.000Z (5 months ago)
• Last Synced: 2024-10-14T07:32:35.014Z (30 days ago)
• Language: TypeScript
• Homepage:
• Size: 165 KB
• Stars: 27
• Watchers: 3
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Meld Build - An Obsidian Plugin

Write and execute (sandboxed) JavaScript to render templates, query DataView and create dynamic notes.

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 'Run' button.  If you are in Source mode, choose `Meld Build: Run` from the command pallette.

````md

```meld-build-toolbar

```

```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}` );

```

````

## Documentation

- [User Guide](/docs/user-guide.md)

- [API](/docs/api.md)

### Examples

- [Guess The Number Game](/docs/examples/guess-the-number.md)

- [Guess The Number Game (Using Markers)](/docs/examples/guess-the-number-marker.md)

- [Simple Invoice Builder](/docs/examples/invoice-builder.md)

## Manually installing the plugin

- Copy over `main.js`, `styles.css`, `manifest.json` to your vault `VaultFolder/.obsidian/plugins/meld-build/`.