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

History

eikek 5de6c8940d Reorganize docs about configuration		2022-03-21 14:41:39 +01:00
..
elm	Website redesign	2022-02-03 21:42:09 +01:00
scripts	Website redesign	2022-02-03 21:42:09 +01:00
site	Reorganize docs about configuration	2022-03-21 14:41:39 +01:00
styles	Add some docs to file backends	2022-03-13 15:20:33 +01: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	Update dependency @tailwindcss/forms to ^0.5.0	2022-03-02 22:06:31 +00:00
postcss.config.js	Website redesign	2022-02-03 21:42:09 +01:00
README.md	Website redesign	2022-02-03 21:42:09 +01:00
shell.nix	Website redesign	2022-02-03 21:42:09 +01:00
tailwind.config.js	Website redesign	2022-02-03 21:42:09 +01:00
yarn.lock	Update dependency @tailwindcss/forms to ^0.5.0	2022-03-02 22:06:31 +00: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.

Sbt is used to build the site.

Install things by running yarn install.

Open terminal for each script below:

Starting the server

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

Building the stylesheet

nix-shell --run ./scripts/run-styles.sh

Open browser at localhost:1111.

The above is great when editing, but doesn't fully reflect what will be finally deployed. To see this, start sbt and change into the website project.

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

Build everything and check for dead links:

sbt> zolaBuildTest
sbt> zolaCheck

sbt> ghpagesSynchLocal

The final site is now generated and a simple http server can be used to see how it will look when deployed.

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