mirror of
https://github.com/logseq/logseq.git
synced 2026-04-24 22:25:01 +00:00
Fix db graph script not creating refs for properties
Also add a readme and fix a bug with generating today pages
This commit is contained in:
32
scripts/README.md
Normal file
32
scripts/README.md
Normal file
@@ -0,0 +1,32 @@
|
||||
## Description
|
||||
This is a collection of development related scripts, written as bash scripts, bb/babashka scripts and nbb scripts.
|
||||
|
||||
## Usage
|
||||
|
||||
### Babashka scripts
|
||||
Most bb scripts live under `src/` and are defined as bb tasks. See [babashka tasks](../docs/dev-practices.md#babashka-tasks)
|
||||
|
||||
### Nbb scripts
|
||||
|
||||
Before running any [nbb-logseq](https://github.com/logseq/nbb-logseq) scripts, be sure to have node >= 18.14 installed as well as a recent [babashka](https://github.com/babashka/babashka) for managing the dependencies in `nbb.edn`. Then `yarn install` to install dependencies
|
||||
|
||||
#### Create graph scripts
|
||||
|
||||
For database graphs, it is possible to create graphs with the
|
||||
[logseq.tasks.db-graph.create-graph](src/logseq/tasks/db_graph/create_graph.cljs)
|
||||
ns. This ns makes it easy to write scripts that create graphs by supporting a
|
||||
concise EDN map for graph generation. For example, the
|
||||
`create_graph_with_properties.cljs` script uses this ns to create a graph with
|
||||
a variety of properties:
|
||||
|
||||
```
|
||||
$ yarn nbb-logseq src/logseq/tasks/db_graph/create_graph_with_properties.cljs ~/logseq/graphs/woot
|
||||
Generating 16 pages and 24 blocks ...
|
||||
Created graph woot!
|
||||
```
|
||||
|
||||
This script creates a DB graph with blocks containing several property types for
|
||||
both single and many cardinality. It also includes queries for most of these
|
||||
properties. Read the docs in
|
||||
[logseq.tasks.db-graph.create-graph](src/logseq/tasks/db_graph/create_graph.cljs)
|
||||
for specifics on the EDN map.
|
||||
Reference in New Issue
Block a user