710549ca8d
Some checks failed
/ build (push) Has been cancelled
Signed-off-by: Minecon724 <git@m724.eu>
44 lines
No EOL
1.9 KiB
Markdown
44 lines
No EOL
1.9 KiB
Markdown
blog-software(config, template, content) = blog website
|
|
|
|
## Usage
|
|
|
|
1. [Download the program from here](/Minecon724/blog-software-java/releases) \
|
|
**Mini** or **Full**? **Full** contains dependencies, which use native libraries. Choose **Full**, if unsure.
|
|
2. Run the program:
|
|
```shell
|
|
java -jar blog-0.0.2-standalone-full.jar -s example_workdir
|
|
```
|
|
|
|
For tips on how to create your own project (workdir), see [Project format](#Project format) below.
|
|
|
|
## 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](/Minecon724/-/packages/maven/eu.m724-blog)
|
|
|
|
## Project format
|
|
[Here's an example blog](/Minecon724/example-blog) you can take inspiration from.
|
|
|
|
Basically:
|
|
- `assets/` - contains static assets
|
|
- `articles/` - contains articles. Post format:
|
|
- Header / metadata:
|
|
- `title A title` - article title
|
|
- `summary This is a article with a title` - article summary
|
|
- `live` - is the article live (not draft), doesn't need an argument
|
|
- Custom properties, which are Strings
|
|
- ` ` - Empty line separates header from content
|
|
- Post content in HTML. Generally not sanitized, but depends on template.
|
|
- `template/` - contains the template, see [Template format](#Template format) below
|
|
- `site-config.yml` - 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, which can be anything as they are Objects
|
|
|
|
## Template format
|
|
[Pebble Templates](https://pebbletemplates.io) is used
|
|
|
|
- `static/` - contains static assets
|
|
- `article_template.html` - article template
|
|
- `index_template.html` - index.html template |