docs: Update and improve README
All checks were successful
/ build (push) Successful in 37s

Signed-off-by: Minecon724 <git@m724.eu>
This commit is contained in:
Minecon724 2025-02-12 16:23:26 +01:00
parent 0b91f2d7a1
commit 567bbd8c37
Signed by: Minecon724
GPG key ID: 3CCC4D267742C8E8

View file

@ -3,13 +3,13 @@ blog-software(config, template, content) = blog website
## Usage ## Usage
1. [Download the program from here](/Minecon724/blog-software-java/releases) 1. [Download the program from here](/Minecon724/blog-software-java/releases)
2. Get a working directory. See [Project format](#Project format) below. 2. Run the program:
Don't forget to `git init`!
3. Run the program:
```shell ```shell
java -jar blog-0.0.1-shaded.jar java -jar blog-0.0.1-shaded.jar -s example_workdir
``` ```
For tips on how to create your own project (workdir), see [Project format](#Project format) below.
## Important caveats ## Important caveats
Generated site must be the root of a subdomain, like `https://example.com/`. \ Generated site must be the root of a subdomain, like `https://example.com/`. \
You can't put it in a directory, like `https://example.com/blog/` You can't put it in a directory, like `https://example.com/blog/`
@ -25,12 +25,19 @@ There's an ["Example workdir"](/Minecon724/blog-software-java/src/branch/master/
Basically: Basically:
- `assets/` - contains static assets - `assets/` - contains static assets
- `posts/` - contains posts - `posts/` - contains posts. Post format:
- Header / metadata:
- `title A title` - post title
- `summary This is a post with a title` - post summary
- `live` - is the post live (not draft), doesn't need an argument
- Custom properties, which are Strings
- ` ` - Empty line separates header from content
- Post content in HTML. Generally not sanitized, but depends on template.
- `template/` - contains the template, see [Template format](#Template format) below - `template/` - contains the template, see [Template format](#Template format) below
- `site-config.json` - the site configuration - `site-config.yml` - the site configuration
- `name: "my blog"` property - site name - `name: my blog` property - site name
- `baseUrl: "https://example.com"` property - URL of the site. It must be a root URL - folders are currently not supported. This is used only for the RSS feed. - `baseUrl: https://example.com` property - URL of the site. It must be a root URL - folders are currently not supported. This is used only for the RSS feed.
- custom properties - Custom properties, which can be anything as they are Objects
## Template format ## Template format
https://pebbletemplates.io is used https://pebbletemplates.io is used