summaryrefslogtreecommitdiff
path: root/themes/lugo/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'themes/lugo/README.md')
-rw-r--r--themes/lugo/README.md21
1 files changed, 21 insertions, 0 deletions
diff --git a/themes/lugo/README.md b/themes/lugo/README.md
new file mode 100644
index 0000000..a39a9e8
--- /dev/null
+++ b/themes/lugo/README.md
@@ -0,0 +1,21 @@
+# Luke's Hugo Theme
+
+A simple Hugo theme I plan on using for my personal website, [Based.Cooking](https://based.cooking) and [LandChad.net](https://landchad.net).
+
+## get started
+
+```sh
+hugo new site new-site
+cd new-site
+git clone https://github.com/lukesmithxyz/lugo themes/lugo
+echo "theme = 'lugo'" >> config.toml
+cp themes/lugo/static/style.css static/
+```
+
+## stuff
+
+- Makes one RSS feed for the entire site at `/index.xml`
+- Stylesheet is in `/style.css` and includes some important stuff for partials.
+- If a post is tagged, links to the tags are placed at the bottom of the post.
+- `nextprev.html` adds links to the Next and Previous articles to the bottom of a page.
+- `taglist.html` links all tags an article is tagged to for related content.