about summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorYihui Xie2017-06-15 23:08:08 -0500
committerYihui Xie2017-06-15 23:08:08 -0500
commit13901ba8b462d06e81d76f503c57be6ccde3ab80 (patch)
tree2b1ed94e0a50f219a97be266abd6ad7327d66314
parentec81eb1d4a8294349a26a9d54dbe7148cec3cdf2 (diff)
downloadhugo-xmin-13901ba8b462d06e81d76f503c57be6ccde3ab80.tar.lz
hugo-xmin-13901ba8b462d06e81d76f503c57be6ccde3ab80.tar.zst
hugo-xmin-13901ba8b462d06e81d76f503c57be6ccde3ab80.zip
add readme and screenshots
-rw-r--r--README.md28
-rw-r--r--images/screenshot.pngbin0 -> 37151 bytes
-rw-r--r--images/tn.pngbin0 -> 21823 bytes
3 files changed, 28 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b073098
--- /dev/null
+++ b/README.md
@@ -0,0 +1,28 @@
+# HUGO XMIN
+
+## _Keep it simple, but not simpler_
+
+**XMin** is a Hugo theme written by [Yihui Xie](https://yihui.name) in about four hours: half an hour was spent on the Hugo templates, and 3.5 hours were spent on styling. The main motivation for writing this theme was to provide a really minimal example to beginners of Hugo templates. This XMin theme contains about 130 lines of code in total, including the code in HTML templates and CSS (also counting empty lines).
+
+
+```bash
+find . -not -path '*/exampleSite/*' \( -name '*.html' -o -name '*.css' \) | xargs wc -l
+```
+
+```
+       5 ./layouts/404.html
+      18 ./layouts/_default/list.html
+      12 ./layouts/_default/single.html
+      16 ./layouts/_default/terms.html
+       0 ./layouts/partials/foot_custom.html
+       9 ./layouts/partials/footer.html
+       0 ./layouts/partials/head_custom.html
+      19 ./layouts/partials/header.html
+       7 ./static/css/fonts.css
+      50 ./static/css/style.css
+     136 total
+```
+
+I can certainly further reduce the code, for example, by eliminating the CSS, but I believe a tiny bit CSS can greatly improve readability. You cannot really find many CSS frameworks that only contain 50 lines of code.
+
+![Screenshot](/images/screenshot.png)
diff --git a/images/screenshot.png b/images/screenshot.png
new file mode 100644
index 0000000..3df0a14
--- /dev/null
+++ b/images/screenshot.png
Binary files differdiff --git a/images/tn.png b/images/tn.png
new file mode 100644
index 0000000..389a20c
--- /dev/null
+++ b/images/tn.png
Binary files differ