commit 71a25bdc708963fc591d12109d19faf9de542149
parent b56ec7ca6c6f16b5daed702dad1cf8768fcf6f77
Author: Shimmy Xu <shimmy.xu@shimmy1996.com>
Date: Fri, 29 Nov 2019 22:56:24 -0500
Add README
Diffstat:
3 files changed, 36 insertions(+), 2 deletions(-)
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,6 @@
The MIT License (MIT)
-Copyright (c) 2019 YOUR_NAME_HERE
+Copyright (c) 2019 Shimmy Xu
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
diff --git a/README.org b/README.org
@@ -0,0 +1,34 @@
+* Djem So
+Djem So is a aggressively stripped down version of my [[https://github.com/shimmy1996/hugo-soresu][Soresu]] theme, which in turn was forked from Yihui Xie's [[https://github.com/yihui/hugo-xmin][XMin]] theme with added support for multilingual blogs. Compared with Soresu, the following changes were made to create Djem So:
+
+- remove CSS classes;
+- remove extra support for i18n taxonomies;
+- remove extra style tweaks on syntax highlighting;
+- reduce number of colors used.
+
+What is retained though is support for multilingual page contents. The result is an bare-bone theme that still allows easy customization. In fact, Djem So has exactly 100 lines, even less than the XMin theme that started it all.
+
+#+BEGIN_EXAMPLE
+ $ find . -path '*/layouts/*' \( -name '*.html' -o -name '*.css' \) | xargs wc -l
+ 5 ./layouts/partials/header.html
+ 6 ./layouts/partials/css/color.css
+ 0 ./layouts/partials/css/custom.css
+ 31 ./layouts/partials/css/style.css
+ 1 ./layouts/partials/footer.html
+ 0 ./layouts/partials/head_custom.html
+ 19 ./layouts/partials/nav.html
+ 11 ./layouts/partials/head.html
+ 1 ./layouts/_default/single.html
+ 14 ./layouts/_default/list.html
+ 12 ./layouts/_default/baseof.html
+ 100 total
+#+END_EXAMPLE
+
+** Customization
+Djem So utilizes a 4-color-palette, and by default uses the [[https://en.wikipedia.org/wiki/Web_colors#Safest_web_colors][safest web colors]], which creates some of the least palatable color combinations (I went to great lengths to ensure the default is at least presentable), to encourage customization. I also left =font-family= unspecified, since preferences seem rather divided.
+
+All customization can be done via overriding default files:
+
+- to change the color palette, override =/layouts/partials/css/color.css=;
+- to add custom CSS rules like font settings, override =/layouts/partials/css/custom.css=;
+- to load additional scripts, or add meta data, override =/layouts/partials/head_custom.html=.
diff --git a/theme.toml b/theme.toml
@@ -11,7 +11,7 @@ features = []
min_version = "0.41"
[author]
- name = ""
+ name = "Shimmy Xu"
homepage = ""
# If porting an existing theme