clone/logseq
1
0
Fork 0
mirror of https://github.com/logseq/logseq.git synced 2026-02-01 22:47:36 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add docs and workflow for dep

Browse Source 
Also rename dep to publishing for consistency with existing names
This commit is contained in:
Gabriel Horner
2023-04-04 18:12:10 -04:00
committed by Tienson Qin
parent 5186070248
commit fef07fe812
28 changed files with 260 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
docs/dev-practices.md
View File

@@ -257,10 +257,29 @@ We strive to use explicit names that are self explanatory so that our codebase i
### Babashka tasks
There are a number of bb tasks under `dev:` for developers. There are also some
tasks under `nbb:` which are useful for inspecting database changes in realtime.
See [these docs](https://github.com/logseq/bb-tasks#logseqbb-tasksnbbwatch) for
more info.
There are a number of bb tasks under `dev:` for developers. Some useful ones to
point out:
* `dev:validate-repo-config-edn` - Validate a repo config.edn
```sh
bb dev:validate-repo-config-edn templates/config.edn
```
* `dev:publishing` - Build a publishing app for a given graph dir. If the
publishing frontend is out of date, it builds that first which takes time.
Subsequent runs are quick.
```sh
# Build the export
$ bb dev:publishing /path/to/graph-dir tmp/publish
# View the app in a browser
$ open tmp/publish/index.html
```
There are also some tasks under `nbb:` which are useful for inspecting database
changes in realtime. See [these
docs](https://github.com/logseq/bb-tasks#logseqbb-tasksnbbwatch) for more info.
### Dev Commands