mirror of
https://github.com/TheAnachronism/docspell.git
synced 2025-06-21 09:58:26 +00:00
Initial website
This commit is contained in:
30
website/README.md
Normal file
30
website/README.md
Normal file
@ -0,0 +1,30 @@
|
||||
# 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`.
|
Reference in New Issue
Block a user