docspell/website
2021-06-19 00:13:43 +02:00
..
elm Add documentation about docker setup 2021-05-31 22:19:49 +02:00
site Fix dead link 2021-06-19 00:13:43 +02:00
build.sh Update build for new website 2020-07-30 20:33:26 +02:00
elm-analyse.json Initial website 2020-07-30 20:33:26 +02:00
elm.json Add search to docs 2020-09-30 00:21:21 +02:00
package.json Initial website 2020-07-30 20:33:26 +02:00
README.md Update website 2020-09-02 22:10:16 +02:00
run-elm.sh Add search to docs 2020-09-30 00:21:21 +02:00
shell.nix Pin nixpkgs to a version with zola-0.11.0 2021-05-31 13:57:26 +02:00
yarn.lock Initial website 2020-07-30 20:33:26 +02:00

Website

This is the docspell website and documentation.

Building

The website is created using 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:

nix-shell --run ./run-elm.sh

and in the second

nix-shell --run "cd site && zola serve"

Open browser at localhost:1111.

Publishing

nix-shell website/shell.nix --run sbt
sbt> project website
sbt> zolaBuild
sbt> zolaCheck

Testing

sbt> zolaBuildTest
sbt> ghpagesSynchLocal

Other terminal:

cd ~/.sbt/ghpages/<some-hash>/com.github.eikek/docspell-website
python -m SimpleHTTPServer 1234

Open http://localhost:1234 in a browser.

Publish

sbt> zolaBuild
sbt> ghpagesPushSite