aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBradley Taunt <bt@btxx.org>2024-07-23 09:36:35 -0400
committerBradley Taunt <bt@btxx.org>2024-07-23 09:36:35 -0400
commitd2a6023d2bf19b08ca61baf809a8b3b526e41169 (patch)
tree21fedbcc69cf60949fedda52f254a86e688e9b60 /README.md
parentf7f421dd3a1a0af1596719949b0024b37ccd0fe3 (diff)
Pull out configuration into separate file,update homepage post count, default post index page
Diffstat (limited to 'README.md')
-rw-r--r--README.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/README.md b/README.md
index ab4c3fe..1552e33 100644
--- a/README.md
+++ b/README.md
@@ -18,7 +18,7 @@ gem install kramdown rss
## Getting Started
-Make your changes in the top of the main `wruby.rb` file (site URL, your name,
+Make your changes in the main configuration file `_config.yml` file (site URL, your name,
etc.). Remove the `.build.yml` unless you plan to host with sourcehut pages,
otherwise edit this file with your own details.
@@ -28,6 +28,12 @@ otherwise edit this file with your own details.
* Pages go under the `pages` directory as markdown files
* Media (images, videos etc) go in the root `public` directory
+## Defaults
+
+* The homepage only displays the first `5` posts. You can configure this in `_config.yml` under `post_count`.
+* The full blog post index will be generated at `yoursite.com/posts`
+ * This means you need to have a `posts.md` file in your `pages` directory (or change `posts_index` the core `_config.yml`)
+
## Running
1. Run `make build` in the root directory