mirror of
https://github.com/TheAnachronism/docspell.git
synced 2024-11-13 02:31:10 +00:00
31 lines
506 B
Markdown
31 lines
506 B
Markdown
|
# Website
|
||
|
|
||
|
This is the docspell website and documentation.
|
||
|
|
||
|
## Building
|
||
|
|
||
|
The website is created using [zola](https://github.com/getzola/zola)
|
||
|
static site generator. The (very minimal) dynamic parts are written in
|
||
|
Elm.
|
||
|
|
||
|
The `build.sh` script builds the site.
|
||
|
|
||
|
|
||
|
## Development
|
||
|
|
||
|
Install things by running `yarn install`.
|
||
|
|
||
|
Open two terminals. In first run:
|
||
|
|
||
|
``` shell
|
||
|
nix-shell --run ./run-elm.sh
|
||
|
```
|
||
|
|
||
|
and in the second
|
||
|
|
||
|
``` shell
|
||
|
nix-shell --run "cd site && zola serve"
|
||
|
```
|
||
|
|
||
|
Open browser at `localhost:1111`.
|