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

Update README
Some checks failed
/ build (push) Has been cancelled
Details

Browse source 
Signed-off-by: Minecon724 <git@m724.eu>
This commit is contained in:
Minecon724 2025-03-11 13:21:23 +01:00
parent 1ee0db9776
commit 710549ca8d
Signed by untrusted user who does not match committer: Minecon724
GPG key ID: 3CCC4D267742C8E8
1 changed files with 2 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
README.md
View file

@ -10,10 +10,6 @@ blog-software(config, template, content) = blog website
``` ```
For tips on how to create your own project (workdir), see [Project format](#Project format) below. For tips on how to create your own project (workdir), see [Project format](#Project format) below.
## Important caveats
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/`
## API ## API
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.
@ -22,7 +18,7 @@ See [Main.java](/Minecon724/blog-software-java/src/branch/master/src/main/java/e
If you need a Maven dependency, [see here](/Minecon724/-/packages/maven/eu.m724-blog) If you need a Maven dependency, [see here](/Minecon724/-/packages/maven/eu.m724-blog)
## Project format ## Project format
There's an ["Example workdir"](/Minecon724/blog-software-java/src/branch/master/example_workdir) which you can take inspiration from. [Here's an example blog](/Minecon724/example-blog) you can take inspiration from.
Basically: Basically:
- `assets/` - contains static assets - `assets/` - contains static assets
@ -41,7 +37,7 @@ Basically:
- Custom properties, which can be anything as they are Objects - Custom properties, which can be anything as they are Objects
## Template format ## Template format
https://pebbletemplates.io is used [Pebble Templates](https://pebbletemplates.io) is used
- `static/` - contains static assets - `static/` - contains static assets
- `article_template.html` - article template - `article_template.html` - article template