diff --git a/README.md b/README.md index 6c50a4d..9c45454 100644 --- a/README.md +++ b/README.md @@ -3,13 +3,13 @@ blog-software(config, template, content) = blog website ## Usage 1. [Download the program from here](/Minecon724/blog-software-java/releases) -2. Get a working directory. See [Project format](#Project format) below. - Don't forget to `git init`! -3. Run the program: +2. Run the program: ```shell - java -jar blog-0.0.1-shaded.jar + java -jar blog-0.0.1-shaded.jar -s example_workdir ``` +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/` @@ -25,12 +25,19 @@ There's an ["Example workdir"](/Minecon724/blog-software-java/src/branch/master/ Basically: - `assets/` - contains static assets -- `posts/` - contains posts +- `posts/` - contains posts. Post format: + - Header / metadata: + - `title A title` - post title + - `summary This is a post with a title` - post summary + - `live` - is the post 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.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 +- `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 https://pebbletemplates.io is used