summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorBrandon <brandon@btkoch.xyz>2024-10-26 20:10:22 -0400
committerBrandon <brandon@btkoch.xyz>2024-10-26 20:10:22 -0400
commitb980df8bf5a29ba8567beba56b97474dd9dbb3c3 (patch)
tree91d5343b6dca6c2e07fa459db1364070818282e1 /README.md
parentcd0279d2787bbf265e12e309b8a61489c727bb2a (diff)
clean unused components, fix hugo.toml to support columns shortcode
Diffstat (limited to 'README.md')
-rw-r--r--README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/README.md b/README.md
index 7cec74e..1308aa7 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,28 @@
# Theme Name
+Portes
## Features
+Barely any, by design. This theme is meant to be as simple as possible. Most sites I've made with it wind up being under 500KiB.
+However, it does have a couple of very basic shortcodes:
+
+### column(s):
+- Create a column block with `{{% columns %}}`
+- Everything inside of the first `{{% column %}}` will be on the left side,
+and everything within the second will be on the right.
+- I may decide to add support for three or more columns, but only if I need it.
+If you decide to patch it in yourself, feel free to shoot me an email and I'll consider adding it upstream.
+
+### icon:
+- Used to add a clickable icon link
+- `{{< icon src="/[your-icon]" alt="[alt-text]" link="https://example.org/[your-account]" >}} `
## Installation
+`
+cd [your site]/themes
+
+git clone https://git.btkoch.xyz/portes.git/
+`
## Configuration
+The top bar will populate with any pages in the menu "main".
+