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

History

eikek 9ada40c634 Merge pull request #2613 from ChanceHarrison/actual-master docs(development.md): Fix minor typos		2024-04-25 15:30:10 +02:00
..
elm	Fixed typo in Main.elm (homepage)	2023-07-05 09:11:19 +02:00
scripts	Addon docs	2022-05-21 00:40:26 +02:00
site	Merge pull request #2613 from ChanceHarrison/actual-master	2024-04-25 15:30:10 +02:00
src/main/scala/docspell/website	Merge pull request #2380 from eikek/custom-processing-data	2023-11-15 19:28:03 +00: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 cssnano to v7	2024-04-25 03:38:18 +00:00
postcss.config.js	Website redesign	2022-02-03 21:42:09 +01:00
push-docs.sh	Remove other now obsolete nix files	2024-03-10 15:38:17 +01:00
README.md	Remove other now obsolete nix files	2024-03-10 15:38:17 +01:00
tailwind.config.js	Website redesign	2022-02-03 21:42:09 +01:00
yarn.lock	Update dependency cssnano to v7	2024-04-25 03:38:18 +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.

Use a dev environment and open terminal for each script below:

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.

$ 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