index : livejrnl-builder.git

c42c0645fda1e02698757bd8e486e805c17d67a9 [patch]

f1f7b31ccad9f0671d940397933f742b81ffc44f

7467a627372650131a1c1c9fc906e2cc68f15d04

c42c0645fda1e02698757bd8e486e805c17d67a9.tar.gz

chore: add README

Diff

 README.md | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..5f0db04
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
# livejrnl-builder

This is the build script that I used to use for my Neocities site with some generic modifications. I didn't include the colour scheme and site-specific templates that I'm currently using. I modeled the included template from the default template at [DeadJournal](https://www.deadjournal.com), colours and all.

## Features

Instead of tables like DeadJournal does, I'm using [Toast](https://github.com/daneden/toast) for a CSS grid framework.

The CSS is built with [sassc](https://github.com/sass/sassc) but you can replace `sassc` with your Sass implementation.

There's also a template that generates XML for an RSS feed.

## Disclaimer

I'm not offering any support for this repo. It mainly exists as a repo with a premade template for [LiveJrnl](https://codeberg.org/berrysweet/livejrnl).

##  Usage

1. `git clone --recurse-submodules git@codeberg:berrysweet/livejrnl-builder.git`
2. Enter the `livejrnl` directory and [setup the venv](https://codeberg.org/berrysweet/livejrnl#install)
3. Edit `config.json`  in `livejrnl-builder` to fit your needs.
4. Run `build.sh`.

After running `build.sh` your files will be found in the `build` directory.