blog-software-java/README.md

22 lines
933 B
Markdown
Raw Normal View History

blog-software(config, template, content) = blog website
2025-01-19 10:15:42 +01:00
## Usage
1. [Download the program from here](https://git.m724.eu/Minecon724/-/packages/maven/eu.m724-blog) \
Locate "Assets" and download the **-shaded**.jar
2025-01-19 10:15:42 +01:00
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`!
3. Run the program:
```shell
java -jar blog-0.0.1-shaded.jar
2025-01-19 10:15:42 +01:00
```
## 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](/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)