From 70bdf25b037947ca1f273104e74d04ec9075cc19 Mon Sep 17 00:00:00 2001 From: berrysweet Date: Tue, 11 Jul 2023 22:26:32 +0200 Subject: [PATCH] docs: update README --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index cdba1be..1e40362 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,21 @@ # livejrnl-rs-templates -Example templates for [livejrnl-rs](https://codeberg.org/berrysweet/livejrnl-rs). \ No newline at end of file +Example templates for [livejrnl-rs](https://codeberg.org/berrysweet/livejrnl-rs). + +## Templates + +### vintage-blog-onepage + +An extremely basic semantic HTML template where the posts are front and center, and all on one page. + +## Usage + +1. Clone the repo +2. In your `config.toml` point the `template` key to the path of the template you want to use (eg. `/home/user/livejrnl-rs-templates/vintage-blog-onepage`) +3. In your `config.toml` point the `template_index` key to the name of the file to generate `index.html` from (eg. `index.html.template`) +4. (Optionally) link a [classless CSS theme](https://github.com/dbohdan/classless-css) in the `
` tag. +5. Generate using `livejrnl-rs`! + +## Remarks + +I am not a web developer. The terminology and code here may not be the best practices. I welcome issues that bring it up, and would love a nudge in the right direction on how to fix them. :) -- libgit2 1.7.2