https://github.com/iver-wharf/wharf-notes
Architectural notes. No hard decisions, but instead notes from research and exploration
https://github.com/iver-wharf/wharf-notes
neuron wharf
Last synced: 11 months ago
JSON representation
Architectural notes. No hard decisions, but instead notes from research and exploration
- Host: GitHub
- URL: https://github.com/iver-wharf/wharf-notes
- Owner: iver-wharf
- Created: 2021-05-24T12:52:26.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2022-05-10T17:22:08.000Z (over 3 years ago)
- Last Synced: 2025-01-16T10:36:46.455Z (about 1 year ago)
- Topics: neuron, wharf
- Language: Markdown
- Homepage: https://wharf.iver.com/wharf-notes
- Size: 408 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: security-considerations-when-importing.md
Awesome Lists containing this project
README
# Wharf architecture
This repo contains notes about the architecture. The ones that are unfinished
will be found under the `stub` directory.
We're using [neuron](https://github.com/srid/neuron) for this to turn it into
a web page with HTML files instead of markdown files.
## Reading:
All commits to `master` are deployed there using GitHub pages.
## Writing
Recommended to use an editor plugin for this. Check the neuron documentation
for [Editor integration](https://neuron.zettel.page/editor.html) for more info.
For comtributors/maintainers with write access to this repo: It's OK to push to
`master` here, as it's mostly used to keep temporary/draft/stub notes.
## Running
### Running via docker
> This will watch the files for changes, but will not automatically refresh your
> browser. You'll have to refresh the page manually.
```sh
docker run --rm -it -p 8080 -v $(pwd):/notes sridca/neuron neuron rib -Sw
```
### Running via neuron
You can run it locally and have it hosted as a web page to see it rendered.
1. Install neuron:
2. Run the `rib` subcommand to generate and host the files on localhost:8080
> This will watch the files for changes, but will not automatically refresh your
> browser. You'll have to refresh the page manually.
```sh
# -S makes it host at localhost:8080
# -w makes it watch for changes and automatically regenerate
neuron rib -Sw
```
3. Visit
## Building
### Building docker image
```sh
docker build -t wharf-notes .
docker run --rm -it -p 8080:8080 wharf-notes
```
### Building via neuron
You can also just generate the files and then host it via for example nginx.
1. Install neuron:
2. Run the `rib` subcommand, but without any arguments
```sh
neuron rib
```
3. Publish the files found in `.neuron/output`
---
Maintained by [Iver](https://www.iver.com/en).
Licensed under the [MIT license](./LICENSE).