aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authoromagdy7 <omar.professional8777@gmail.com>2023-11-02 23:55:13 +0200
committeromagdy7 <omar.professional8777@gmail.com>2023-11-02 23:55:13 +0200
commitc38d70c1752234bfc041c7fd5d762eec83cfbb9b (patch)
tree3a94ec905db50dc2f217d0390c718dc17272d2ba /README.md
downloadollama-logseq-c38d70c1752234bfc041c7fd5d762eec83cfbb9b.tar.xz
ollama-logseq-c38d70c1752234bfc041c7fd5d762eec83cfbb9b.zip
First commit
Diffstat (limited to 'README.md')
-rw-r--r--README.md31
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
+
+![demo](./demo.gif)
+
+### API
+
+[![npm version](https://badge.fury.io/js/%40logseq%2Flibs.svg)](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.