https://github.com/dundalek/humble-outliner
https://github.com/dundalek/humble-outliner
Last synced: 8 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/dundalek/humble-outliner
- Owner: dundalek
- License: mit
- Created: 2023-05-21T14:35:14.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-02-28T20:05:09.000Z (over 1 year ago)
- Last Synced: 2025-05-26T19:04:29.206Z (23 days ago)
- Language: Clojure
- Size: 57.6 KB
- Stars: 14
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Humble Outliner
This is a demo project implementing an outliner view inspired by [Logseq](https://logseq.com/) using [HumbleUI](https://github.com/HumbleUI/HumbleUI).
It is based on the [humble-starter](https://github.com/lilactown/humble-starter) template.
The focus of the demo is on the UI, it is not indented for use as it does not store data permanently.
https://github.com/dundalek/humble-outliner/assets/755611/c8103408-84c6-491c-a253-d25c24b7189c
## Features
- `up/down` go up/down
- `enter` new item
- `backspace` join items
- `tab` indent
- `shift+tab` outdent
- `alt+shift+up/down` move item up/down
- switch between light and dark theme
## Not Implemented
Features they might be interesting to implement as an exercise in the future:
- [ ] block-wise selection
- [ ] collapse/expand
- [ ] zoom in/out
- [ ] undo/redo
- [ ] copy/paste
- [ ] dragging
- [ ] text wrapping
- [ ] rich text formatting
## Demo
Run the app with:
```sh
script/run.sh
```
### Building executable with GraalVM native-image
Make sure to have `GRAALVM_HOME` env variable pointing to your GraalVM installation, e.g.:
```sh
export GRAALVM_HOME="$HOME/Downloads/graalvm-jdk-21.0.1+12.1"
```
Compile with:
```sh
clj -T:build native
```
Run the executable:
```sh
target/outliner
```
See [humble-graal](https://github.com/dundalek/humble-graal) for more details.
## Development
Run the app including nREPL server:
```sh
script/nrepl.sh
```
Run tests with:
```sh
clj -M:test
```
Run tests with alternative reporter:
```sh
clj -M:test --reporter kaocha.report/documentation
```
Run tests in watch mode:
```sh
clj -M:test --watch
```
Generate code coverage report:
```sh
clj -M:test:coverage
```
### Reloading
To reload the app and see your changes reflected, you can:
1. Evaluate individual forms via the REPL, reset the `state/*app` atom, and then
call `state/redraw!`
2. Make changes to the files, save them, then call `reload` from the user ns,
which will use [clojure.tools.namespace](https://github.com/clojure/tools.namespace)
to detect which ns' should be refreshed, evaluate them, and then call
`state/redraw!`.
## License
Licensed under MIT.
Copyright Jakub Dundalek 2023.
Parts of the code Copyright Will Acton 2022.