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

History

Vladimir Timofeenko eca08c7416 nix: add development vm This commit adds back the ability to run a development VM with docspell. See updated documentation for examples.		2022-12-23 18:57:34 -08:00
..
elm	Website redesign	2022-02-03 21:42:09 +01:00
scripts	Addon docs	2022-05-21 00:40:26 +02:00
site	nix: add development vm	2022-12-23 18:57:34 -08:00
src/main/scala/docspell/website	Fix compile errors in website examples	2022-08-07 16:44:44 +02: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 postcss-import to v15	2022-08-31 03:41:57 +00:00
postcss.config.js	Website redesign	2022-02-03 21:42:09 +01:00
push-docs.sh	Merge branch 'current-docs'	2022-05-22 13:43:50 +02: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	Merge remote-tracking branch 'origin/current-docs'	2022-11-04 23:50:37 +01: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