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

History

mergify[bot] e51c2f63f1 Merge pull request #409 from eikek/doc-updates Doc updates		2020-10-29 23:48:20 +00:00
..
elm	Allow to click to start searching	2020-10-29 22:59:58 +01:00
site	Merge pull request #409 from eikek/doc-updates	2020-10-29 23:48:20 +00: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	Fix zola version to 0.11.0	2020-09-11 23:20:12 +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