Skip to content

Commit

Permalink
Updated contributor docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
oubiwann committed Dec 24, 2023
1 parent 849381b commit 0076710
Showing 1 changed file with 12 additions and 16 deletions.
28 changes: 12 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
Expand All @@ -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:
Expand All @@ -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 [email protected]:lfe/site-staging.git
Expand Down

0 comments on commit 0076710

Please sign in to comment.