No description
Find a file
Minecon724 d4757d71a2
Some checks failed
/ build (push) Failing after 13s
chore: Update deps
Signed-off-by: Minecon724 <git@m724.eu>
2025-02-10 16:26:28 +01:00
.forgejo/workflows ci: fix artifact path 2025-02-10 16:26:23 +01:00
.idea this 2025-01-10 14:43:24 +01:00
.mvn/wrapper feat: add Maven Wrapper and signing setup 2025-02-08 13:41:01 +01:00
example_workdir Improve example 2025-01-19 10:30:35 +01:00
src/main/java/eu/m724/blog refactor: clean up unused imports 2025-02-08 16:01:06 +01:00
.gitignore made it work 2025-01-08 18:40:11 +01:00
mvnw feat: add Maven Wrapper and signing setup 2025-02-08 13:41:01 +01:00
mvnw.cmd feat: add Maven Wrapper and signing setup 2025-02-08 13:41:01 +01:00
pom.xml chore: Update deps 2025-02-10 16:26:28 +01:00
README.md docs: Add more to README 2025-02-10 16:26:08 +01:00
testkeystore.jks feat: add Maven Wrapper and signing setup 2025-02-08 13:41:01 +01:00

blog-software(config, template, content) = blog website

Usage

  1. Download the program from here
  2. Get a working directory. See [Project format](#Project format) below. Don't forget to git init!
  3. Run the program:
     java -jar blog-0.0.1-shaded.jar
    

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

There's no "API," but it's possible to integrate this into your Java project.

See Main.java for an example.
If you need a Maven dependency, see here

Project format

There's an "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