mirror of https://github.com/TheAnachronism/docspell.git synced 2024-11-13 02:31:10 +00:00

History

eikek 8dd844b1d4 Add dashboard docs		2022-01-26 22:23:40 +01:00
..
elm	Fixing links in the getting started page	2021-11-22 13:16:04 +01:00
site	Add dashboard docs	2022-01-26 22:23:40 +01: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	Update zola to 0.14.1 and fix doc search	2021-10-25 17:24:20 +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.

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.

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

sbt> zolaBuild
sbt> zolaCheck

sbt> zolaBuildTest
sbt> ghpagesSynchLocal

Other terminal:

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

sbt> zolaBuild
sbt> ghpagesPushSite