Minecon724/blog-software-java
1
0
Fork 0
Code Issues 4 Pull requests Projects Releases 1 Packages 1 Wiki Activity Actions 1

docs: Add more to README

Browse source 
Signed-off-by: Minecon724 <git@m724.eu>
This commit is contained in:
Minecon724 2025-02-10 16:26:08 +01:00
parent 37535e2c35
commit 930a22d55a
Signed by: Minecon724
GPG key ID: 3CCC4D267742C8E8
1 changed files with 22 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -2,9 +2,8 @@ blog-software(config, template, content) = blog website
## Usage ## Usage
1. [Download the program from here](https://git.m724.eu/Minecon724/-/packages/maven/eu.m724-blog) \ 1. [Download the program from here](/Minecon724/blog-software-java/releases)
Locate "Assets" and download the **-shaded**.jar 2. Get a working directory. See [Project format](#Project format) below.
2. Get a working directory. [Example](https://git.m724.eu/Minecon724/blog-software-java/src/branch/master/example_workdir) \
Don't forget to `git init`! Don't forget to `git init`!
3. Run the program: 3. Run the program:
```shell ```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. 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. \ 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) 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