diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..5d17030 --- /dev/null +++ b/README.md @@ -0,0 +1,31 @@ +## Reddit Hot News Sample + +This is a sample that show you how to manipulate blocks :) + +### Demo + + + +### API + +[](https://badge.fury.io/js/%40logseq%2Flibs) + +##### [Logseq.Editor](https://logseq.github.io/plugins/interfaces/ieditorproxy.html) + +- `insertBlock: ( + srcBlock: BlockIdentity, content: string, opts?: Partial<{ before: boolean; sibling: boolean; properties: {} }> + ) => Promise<BlockEntity | null>` +- `insertBatchBlock: ( + srcBlock: BlockIdentity, batch: IBatchBlock | Array<IBatchBlock>, opts?: Partial<{ before: boolean, sibling: boolean }> + ) => Promise<Array<BlockEntity> | null>` +- `updateBlock: ( + srcBlock: BlockIdentity, content: string, opts?: Partial<{ properties: {} }> + ) => Promise<void>` +- `removeBlock: ( + srcBlock: BlockIdentity + )` + +### Running the Sample + +- `npm install && npm run build` in terminal to install dependencies. +- `Load unpacked plugin` in Logseq Desktop client. |