TheAnachronism/docspell
1
0
Fork 0
mirror of https://github.com/TheAnachronism/docspell.git synced 2024-11-13 02:31:10 +00:00
Code Issues Packages Projects Releases Wiki Activity
de3216f634
docspell/website
History
Eike Kettner de3216f634 Update screencast videos
2020-11-15 00:01:48 +01:00
..
elm Update screencast videos 2020-11-15 00:01:48 +01:00
site Update screencast videos 2020-11-15 00:01:48 +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 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

README.md

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

Check Links

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