search

HananoshikaYomaru / obsidian-run

Generate markdown from dataview query and javascript.
https://yomaru.dev
MIT License
38 stars 2 forks source link
dataview obsidian

readme

Obsidian Run

Generate markdown from dataview query and javascript.

demo: https://www.youtube.com/watch?v=_UAr6e6hlVI&t=71s

Installation

Plugin marketplace

You can download this from obsidian plugin store.

Manual Installation

  1. cd to .obsidian/plugins
  2. git clone this repo
  3. cd obsidian-run && bun install && bun run build
  4. there you go 🎉

Usage

  1. install this plugin and install obsidian-custom-save
  2. add the run: run file command to the custom save actions
  3. define a starting tag
%% run start 3+4%%
  1. save the file
  2. you markdown will become something like this
%% run start
3+4
%%
7
%% run end %%

Syntax

Each block of run contains three parts: starting tag (required), generated content, ending tag

starting tag (required)

you define your expression in the starting tag. The expression will be used to calculate the content. It is the only required part for a run block.

%% run start <expression> %%

or you can also write multiple line statements. Notice that if you write in multiple line you must return a value.

%% run start

```ts|js
<your expression in codeblock>

%%


You can use it with [CodeblockCustomizer](https://github.com/mugiwara85/CodeblockCustomizer), to have folding codeblock.

![](https://user-images.githubusercontent.com/43137033/272329457-d278a370-63d6-4dc2-a3f4-68767745ac92.png)

#### Content

the generated content

#### Ending Tag

ending tag closes the run block.

```md
%% run end <metadata> %%

Options

  1. generate ending tag metadata: when enabled, the run block update time and error(if any) will be shown in the ending tag.
  2. ignore folders: the folder listed will be ignored by this plugin

Advanced Usage

Access file object

%% run start file.basename %%

the file object is the TFile but it is patched with file.properties which is the file yaml properties.

Page level variable

---
bar: "foo"
---

%% run start file.properties.bar %%

Dataview

you can access the dv object if you have dataview plugin installed and enabled.

%% run start

```ts
return dv.markdownList(dv.pages("#ai/image").map((page) => page.file.link));

%%


### Templater and Reusable user scripts

you can access the `tp` object if you have templater plugin installed and enabled.

> Then you need to go to the setting of template and manually set a startup template. The reason of doing this is that `tp` is not initialized by default by templater and it will be undefined. Learn more and see a video: <https://github.com/HananoshikaYomaru/obsidian-run/issues/14#issuecomment-1749945619>. If you don't want to set a start up template, you can manually run templater once everytime you start up obsidian. As long as templater runs once, the `tp` object will be defined.

![](https://share.cleanshot.com/qwTYFCby+)

Templater allows user to have their user defined functions and scripts. To learn more, checkout <https://silentvoid13.github.io/Templater/user-functions/script-user-functions.html>.

### Function

you can write complicated function in starting tag codeblock

### Async Function

You can do any kind of async operation in the run block. Async function is non-blocking. Results will be resolved after all sync operation are resolved. You can use the obsidian [request](https://docs.obsidian.md/Reference/TypeScript+API/request) function to fetch data.

![](https://share.cleanshot.com/83hQltDB+)

### Debug

you can use `console.log` in the starting tag codeblock. It will output in the developer tool.

## Note

1. if you want to contribute, please star and open github issue.
2. this plugin is powerful, but it is still under early development. The syntax is subject to change but will be backward compatible as much as possible
3. you will want to use this with [CodeblockCustomizer](https://github.com/mugiwara85/CodeblockCustomizer) to collapse your code block.
4. you will want to save the following codeblock as template so that you can use it easily.

````md
%% run start

```ts fold
return;

%%



## Support

If you are enjoying this plugin then please support my work and enthusiasm by buying me a coffee on <https://www.buymeacoffee.com/yomaru>.

<a href="https://www.buymeacoffee.com/yomaru" target="_blank"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Buy Me A Coffee" style="height: 60px !important;width: 217px !important;" ></a>