From 00767107696470c4674169f161c549762a8f852a Mon Sep 17 00:00:00 2001 From: Duncan McGreggor Date: Sun, 24 Dec 2023 16:50:56 -0600 Subject: [PATCH] Updated contributor docs. --- README.md | 28 ++++++++++++---------------- 1 file changed, 12 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 033e318..01b8bad 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,6 @@ Note that the entire site content is driven with Markdown files -- *including* t The front page's content is in TOML variables between the `+++` metadata markers in `./content/_index.md`. -If you're intersted in updating the CSS, everything you need to tweak should be in `./sass/lfe/_variables.scss`. - More about the static site generator software: * [zola docs](https://www.getzola.org/documentation/getting-started/installation/) @@ -22,6 +20,16 @@ The templating language used by zola and which drives the layout/design of the L * [tera](https://tera.netlify.app/docs#templates) +If you're intersted in updating the CSS, we use TailwindCSS + Preline, and everything you need to tweak should be in `./styles/*` (and mostly `site.css`). + +Before submitting a PR we recommend running the spell checker: + +```shell +make spell-check +``` + +(requires [aspell](http://aspell.net/)). + ## Dev Server If you would like to run the site locally, you may do so with this command: @@ -41,23 +49,11 @@ zola serve -p 5099 ## Publishing -To re-deploy the site with changes made to the above-mentioned files, simply do the following: - -```shell -make publish -``` - -You may want to check the spelling first, though: - -```shell -make spell-check -``` - -(requires [aspell](http://aspell.net/)) +The Github Actions for this repo now regenerates content and CSS as part of the CI/CD workflows, automatically re-publishing the site for all successful merges to `main`. ## Publishing to Staging -The staging site is hosted in [another LFE repo](), and thus requires a custom remote URL to be added to your local git clone: +The staging site is hosted in [another LFE repo](https://github.com/lfe/site-staging), and thus requires a custom remote URL to be added to your local git clone: ```shell git remote add staging git@github.com:lfe/site-staging.git