From 930a22d55a3f52f864c08a92135f54eb31afc136 Mon Sep 17 00:00:00 2001 From: Minecon724 Date: Mon, 10 Feb 2025 16:26:08 +0100 Subject: [PATCH] docs: Add more to README Signed-off-by: Minecon724 --- README.md | 26 ++++++++++++++++++++++---- 1 file changed, 22 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 7a74eaf..6c50a4d 100644 --- a/README.md +++ b/README.md @@ -2,9 +2,8 @@ blog-software(config, template, content) = blog website ## Usage -1. [Download the program from here](https://git.m724.eu/Minecon724/-/packages/maven/eu.m724-blog) \ - Locate "Assets" and download the **-shaded**.jar -2. Get a working directory. [Example](https://git.m724.eu/Minecon724/blog-software-java/src/branch/master/example_workdir) \ +1. [Download the program from here](/Minecon724/blog-software-java/releases) +2. Get a working directory. See [Project format](#Project format) below. Don't forget to `git init`! 3. Run the program: ```shell @@ -19,4 +18,23 @@ You can't put it in a directory, like `https://example.com/blog/` There's no "API," but it's possible to integrate this into your Java project. See [Main.java](/Minecon724/blog-software-java/src/branch/master/src/main/java/eu/m724/blog/Main.java) for an example. \ -If you need a Maven dependency, [see here](https://git.m724.eu/Minecon724/-/packages/maven/eu.m724-blog) \ No newline at end of file +If you need a Maven dependency, [see here](/Minecon724/-/packages/maven/eu.m724-blog) + +## Project format +There's an ["Example workdir"](/Minecon724/blog-software-java/src/branch/master/example_workdir) which you can take inspiration from. + +Basically: +- `assets/` - contains static assets +- `posts/` - contains posts +- `template/` - contains the template, see [Template format](#Template format) below +- `site-config.json` - the site configuration + - `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. + - custom properties + +## Template format +https://pebbletemplates.io is used + +- `static/` - contains static assets +- `article_template.html` - post template +- `index_template.html` - index.html template \ No newline at end of file