From ac516333b5f86fd47e5ac7179550d621dc0f1eb6 Mon Sep 17 00:00:00 2001 From: Joe Hutchinson Date: Mon, 7 Feb 2022 16:45:57 -0500 Subject: [PATCH 1/7] Update README.md to include headshot image param --- README.md | 1 + 1 file changed, 1 insertion(+) diff --git a/README.md b/README.md index 0b9beb8..e627c95 100644 --- a/README.md +++ b/README.md @@ -39,6 +39,7 @@ disqusShortname = "Your shortname for Disqus - optional" github = "URL to your Github account - link will be included in the footer" linkedin = "URL to your Linkedin account - link will be included in the footer" bgimg = "Path, within the 'assets' folder, of the image used for the page background - optional" + headshotimg = "Path, within the 'assets' folder, of the image used for the home page header - optional" rssinmenu = whether you would like a RSS feed link to appear in the navigation menu (true, false) - optional [markup] From 56f9b1ee83c92a68662024e8c1aa85c97a6993df Mon Sep 17 00:00:00 2001 From: Joe Hutchinson Date: Wed, 9 Feb 2022 13:17:35 -0500 Subject: [PATCH 2/7] Add more social icons to footer (#70) * Enable markdown in post titles * Update footer icons to no atrib assets --- README.md | 17 ++++-- assets/icons/facebook.svg | 21 ++++++++ assets/icons/flicker.svg | 16 ++++++ assets/icons/github.png | Bin 3506 -> 0 bytes assets/icons/github.svg | 23 +++++++++ assets/icons/home-page.png | Bin 1236 -> 0 bytes assets/icons/home.svg | 55 ++++++++++++++++++++ assets/icons/instagram.svg | 23 +++++++++ assets/icons/linkedin.png | Bin 1469 -> 0 bytes assets/icons/linkedin.svg | 27 ++++++++++ assets/icons/patreon.svg | 15 ++++++ assets/icons/rss.svg | 72 ++++++++++++++++++++++++++ assets/icons/soundcloud.svg | 18 +++++++ assets/icons/spotify.svg | 26 ++++++++++ assets/icons/tumblr.svg | 22 ++++++++ assets/icons/twitch.svg | 18 +++++++ assets/icons/twitter.svg | 39 ++++++++++++++ assets/icons/vimeo.svg | 26 ++++++++++ assets/icons/youtube.svg | 29 +++++++++++ layouts/_default/home.html | 2 +- layouts/_default/li-next.html | 2 +- layouts/_default/li.html | 2 +- layouts/_default/list.html | 2 +- layouts/_default/single.html | 2 +- layouts/partials/footer.html | 94 ++++++++++++++++++++++++++++++++-- 25 files changed, 538 insertions(+), 13 deletions(-) create mode 100644 assets/icons/facebook.svg create mode 100644 assets/icons/flicker.svg delete mode 100644 assets/icons/github.png create mode 100644 assets/icons/github.svg delete mode 100644 assets/icons/home-page.png create mode 100644 assets/icons/home.svg create mode 100644 assets/icons/instagram.svg delete mode 100644 assets/icons/linkedin.png create mode 100644 assets/icons/linkedin.svg create mode 100644 assets/icons/patreon.svg create mode 100644 assets/icons/rss.svg create mode 100644 assets/icons/soundcloud.svg create mode 100644 assets/icons/spotify.svg create mode 100644 assets/icons/tumblr.svg create mode 100644 assets/icons/twitch.svg create mode 100644 assets/icons/twitter.svg create mode 100644 assets/icons/vimeo.svg create mode 100644 assets/icons/youtube.svg diff --git a/README.md b/README.md index e627c95..66aea16 100644 --- a/README.md +++ b/README.md @@ -36,11 +36,22 @@ disqusShortname = "Your shortname for Disqus - optional" [params] brand = "The name that is displayed in the top left of the website, consider it the website name" description = "The website's description" - github = "URL to your Github account - link will be included in the footer" - linkedin = "URL to your Linkedin account - link will be included in the footer" + facebook = "URL to your Facebook account - link will be included in the footer" + flicker = "URL to your Flicker account - link will be included in the footer" + github = "URL to your GitHub account - link will be included in the footer" + instagram = "URL to your Instagram account - link will be included in the footer" + linkedin = "URL to your LinkedIn account - link will be included in the footer" + patreon = "URL to your Patreon account - link will be included in the footer" + soundcloud = "URL to your Soundcloud account - link will be included in the footer" + spotify = "URL to your Spotify account - link will be included in the footer" + tumblr = "URL to your Tumblr account - link will be included in the footer" + twitch = "URL to your Twitch account - link will be included in the footer" + twitter = "URL to your Twitter account - link will be included in the footer" + vimeo = "URL to your Vimeo account - link will be included in the footer" + youtube = "URL to your Youtube account - link will be included in the footer" bgimg = "Path, within the 'assets' folder, of the image used for the page background - optional" headshotimg = "Path, within the 'assets' folder, of the image used for the home page header - optional" - rssinmenu = whether you would like a RSS feed link to appear in the navigation menu (true, false) - optional + rssinmenu = whether you would like a RSS feed link to appear in the navigation menu and footer (true, false) - optional [markup] [markup.highlight] diff --git a/assets/icons/facebook.svg b/assets/icons/facebook.svg new file mode 100644 index 0000000..5b3f7aa --- /dev/null +++ b/assets/icons/facebook.svg @@ -0,0 +1,21 @@ + + + + + + diff --git a/assets/icons/flicker.svg b/assets/icons/flicker.svg new file mode 100644 index 0000000..d9721a3 --- /dev/null +++ b/assets/icons/flicker.svg @@ -0,0 +1,16 @@ + + + + + + + + + diff --git a/assets/icons/github.png b/assets/icons/github.png deleted file mode 100644 index 84b62600a076927f00f04811a1331b0950a3a928..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 3506 zcmV;j4NdZiP)t#%Z&@W?Bp#iuOd6T0az-D9*nLy=c?lHhmfDJ|X+5ub- zG**bGvf~rTG85I|Wyo9GJ1Yi*wxW>xzMh*nSt%zxCwzi66w&or1a1 zFU8H0T{3RP+|1&nsXHun!etBabF%S8j0GOVE;)tEMKN?Px73+k9+vYs4cWNDjs7;K z&W9~^qDmWZJK`tTXaObz*8vNGrx2fcE3$6y3Vy#H{B0p{EpR$^>%bw%taatBmH3%_ zzpB%Tcq7Y#Mog>iO2oWS3^(J};c!_Cj0X-!2H-zL8!25%2Qo-AkXiUe{9MK7#Pqcv zuv*o5g)$iJV9v>I_)koQur1@Zaxq==FGGZ{Jq;{mZe>x2byDNm=UBHk@_1 zS#5h`c3yWnhhB(HD9Wq&KJXZ_1WpG|KswnUk!Bi#-$Q{D5e4lQWER>Co?VC=_iUm) zl*g+3-*)ITK_A~%b?>3g@d^pH`%;D@`g7h;?xZX0GA*h%{UCB zuq_I}jA6_a`6~qJzd4D`%{V%BcyNK~L#zpIW zl|qqiIq-*sOueqID`rwi0eXp9ov{8QMC{F>0l2hSg<=CzkF0}X%tDl%B+vs=OEct9 zb)7VDt`m7?VVs9&*y?E%PPfhY*_^IYbbjH(Oh$N;Lf${=L8CXO=zoe2GYd#(LmI2- zyzEJ*(rBVkTy7`cDiMXb6h4EwNeT4CG%bA8lbO8~txjM+Pg<44BntcgbP2Rh!CY+; zS%Obi1lHmo-gyG10q=BAT9w4L6!N?g_>d>9dPJEH(>o~%f$vk|6bn#?81=%m7E>E% zG5TSO?01$xPj3O=OH%n!Rrvx>CO)g^ypL%9wSuV>^521&?R{{eqP4`eVsFGR5w7fe zBw&f6bF(L%Eb%7_`=G^GR}98{Ii1WwN2!WQm7yF)QMh;PM9dbo2Cc2XgTH^{HATw^ z2(hi@Bh~dX&&H=xCerg*KeUtBiXr>?aq*D!8s;+%!$SdmFX@=-Cb*nrY?n|Loy9IdDgHE+z zox1i79@o#(IKOBc5N#gV;L)(w#NY9tQBByPuKQT;ipP8E+Azh~21GlBwps3pgFYas zJ5+1vQrEtU?G|-yxWQd!$X1Vr^_$@PMpX;+gY#K6z_NozD@|=i-1l1ucN)M!u z4Tu7qTcW!VU&zLwZ1!nfN42L_KIg+sm0&UDc_zk8v(1n#z&@etD-btqD>BM$h#kh3 zcPjUmv>>rlSA_mH3Gp%48v0SFQ*|PN9_tWe<5u#|1oAT`Tz?;AWf=ziDD*d{{rLq7 zM{#u09t0Sp=xn97jzs71B?|lTR0*_3D_YO%8=_`N82bY+2EQATAcaGb(cTx)IR=u? z?ADAJ-?Z}7goNzZlEt?t@D25UV-TC%4)QC-c0`a_AN;!k35ZyY7!-3!(zI}(pS2YW zDICSW0e=k$ml_zo8Hx3(6*PNorrYNfcTN z@A!HoXG)qm7K@<{37374Xz6h_>4hwn6b3X-Reqc3O}G*GDYDnJ0e?njRMh<~$jRL( zF|h+VDRm{1Ni@yPzX{n3=3wpN;4jESyc9VaeGIa%h0~1J1=szNeQ6xK15DcL|U zI{}`1$CcPPXI3II+Bwpx)c^u*6K7{HqrJ_qL_YFjR192Tc%CX&p5i9W`Oy#W9 z(uoKaKSRP?E1?Hz?ocV^4v+RrK^Im!(v!@V$%W=pCughd4nT>4|*T?kAiBGGx+eksI*BjDv zL{GVkDLx=wh`uocG2!bN+5U)$dLoj;@KseemvGWm6t-o3+eBq_oq9}xClw|05X{5@ zQAt>OU?!;9gnP!FxbhVb{*Ok?6k$4ddC*CUX{yb3Qatc_uOj{?(TDoKuI}B89Q=&? zB0^j-d2FjDi zY8>Wja7`K7p%L+Lg&SIhed!vB`LO5U_9cX)RlPP!n;khcVoGe2QlJ|~Go~Q2oHBk* zVFKm`y)fcln^Wo^$YwW`=;K`1s5KNj=jH9IMv89x^1U`kV)h!%%kP%8s+5;DW|CO*AX21|ubztn|9 zZcO&1R|^9&1$(m2ucg6Y8n^+IxemlHo)pzSATzK#(c<#MR~(mPXLJ$CPOVn!fHY&* zt*Y{qM>(92JxA^;#1!s=Y8;T`v40e7ClYT})tHFgsnmg(PvYWZt7$-*kWXsZX8r~; zl%|qm2&VFwD{B#rIm*dZ4Fgh-NJ~*4Fn*HSI#vOQmO7hgh45L-1T|RhOB==L*CTFM zod7w!U(CYoux!=hR3yiTt%F@i;KW7bGoEHKAbkQJmKEW1ITbJzRti0lPc~>1L%3{0 zQs`BBK<>m;@WN#qVu7x?4-&gzC~|_zC8RS~(p;^fOFZonjh+ymixX zd-Gb66RR&EksPbZAE#?aW*3OQ(|{Z=8yK`R8p+&tB!$Plqp%B!1)haCoAxLSLITH% zMWR=#tO`N`=11+{8`^nbe_p3-?#tOs-vx58~{%&-m g8{OzeH$G7KKgtg1KxC9Ang9R*07*qoM6N<$f{hG^=>Px# diff --git a/assets/icons/github.svg b/assets/icons/github.svg new file mode 100644 index 0000000..bb14e47 --- /dev/null +++ b/assets/icons/github.svg @@ -0,0 +1,23 @@ + + + + + + diff --git a/assets/icons/home-page.png b/assets/icons/home-page.png deleted file mode 100644 index ca09cf21f40995e708287c81dadc610dbc087db3..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1236 zcmeAS@N?(olHy`uVBq!ia0vp^DImzD)SRv$V zFt_%=noE28rl>c(pTN9Ve#YI9a)ukiE2?=SVrE^RxJl|qYe_*qL;ltb@v1F<+m;@? zyokR-dWMqhmF@!t?6o}VrGLK#d)}|jy_L^$to2)+B=fa$n@v(i95OC)f2NmAKgXw< zyJR096aUr>Yq1RVsTcKXR*7miZeGGZ=P7giW9BEa3-5nEVBAz)2zZ!mB9WvlI>ymYU3)dcm%rIxp%TB5&mEj?yD`_(q?iYZMtOf{|+ zOXmhRoMn8_+;CR;K(goFdBRUb6Pmsp$YWAgy>WlyjZbg=RrYDg|}1MWM-FXhHudm60m80Qqny^HnDnhWdmBD-#9Ph8QfpuFS2Z@zwJ z{qPsz_g08MaeUzX#Qlo-fu>h6+ALR_beR1Vmv_H^d~J2oVfojavhMCYuJ$D4qx^%f zTz|Es>Tf>fkI~UeX4@cbxzv{1CUkE0(hriKgcHq0Wv*mzz4JjcuT!P$858@2+RKjy@F4Uo(Oz!bWv|UyBh1`@CH*?>2RObYg=MnC1eh~UEz88 zbM%9cNXaa#wDBHJ?XxXogEtaQmd|Pezc@ohmns!>I{Wb298q_n=}ry z1h#Q5;t_U{l=2suw%2BH*3*M&FeMj$$UU0;-8k;6SkqaodN2)h>uECCx7qgA`xO1( zU#i2Z&)&bRdUtn#?L3Kek1s3gTshYqKRYS#iS~(A#}|LB^SJmer2n{FB!*)!4TicB zD6wp_d{WBcZ_ck=)SEo)CDVQSH + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + diff --git a/assets/icons/instagram.svg b/assets/icons/instagram.svg new file mode 100644 index 0000000..6f9304c --- /dev/null +++ b/assets/icons/instagram.svg @@ -0,0 +1,23 @@ + + + + + + diff --git a/assets/icons/linkedin.png b/assets/icons/linkedin.png deleted file mode 100644 index 8caa731b4616f8e2976cc7fa0402327aeccd26d2..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 1469 zcmV;u1w#6XP)|vmmX9z#^~`v+bXyyATxhk|?f%Q3OR) zRKE3S(1TKJZ)pWWQ21a$FO>@sM1PDDB1)uETb82Q)m4M7aIL$R>-O+-@!sE^d*{r| znS0Nj`F-HP9r*ozbLRJD?wL7%=73=shG7_nVHiexnUm750t^5ffmOiOz$Lya)uo&U zjsgdOy}%IgUpr1b0E_@LR$7*k^SR26i-4B`xX^AY=YYZUx$};Rk-iM3$ahNy5VdPh zQU!JZtFiV2BnPX3ok(uS}tWSoP` zoBB)&AL9av@|VjCi;*4^Brr^nz{p#W9$*vlxHk;^1^fvd23`m5&iVX>MEA?MayxJ+ z!e5tm0N+9UcMp89$MqvL{XRrb@s zn@HbI53m5~3)=~tRkn}&sBmC(T#&Do{ni$?+m!7mnQ9s)9T#Mx#`YYrxP|Rf75n#0 zH4T$Q`OD+6ce>{H9AKWKEr@`nCJ#Z5sN-i^*gm3;fAn0JLXz|^>nUY_7I_K04e9+{ zh&1rqfHTUrm3ZAs$J>w!@(7#svG*|c*qd9xYk*%Pe4CXMz;!+<8z4al0BASHY{<6~A`w(OoaIu4L6pMj<5i#FR7^k#?)DDbIBfZX9nFqWZQI~ZI zVw6^pCy@0RRp4m{dsi-{aRtB+$ov2oN-GG+va)8&>lOg>9ph+jMee%V`mA^KEwv!E zECikeK0{_p&c+!>){sAddqWTKo~qA~qn`-^+=D!(Mm6-c<$K@`$C!P}w~E_h*U}5J z9{4xHzgejQ_d3SbT`(?E+6^WfHfkth<%pb_btQ3-XcjIRiWo zTv21Q40xHwM*0JX_>U={y$(L56=Y?E&!a8uw?x>lh&e~UvOnlhuhI(gqO#xT;Im)( zybxo5gR(#AaE?URQKS*Wes#Rt!RL*b7@7%n+>sT@-ExPFD|?q|Mb|5zV=?wU%HCz_ zYia+o^k*zw-pc1IpQ#M>^hfZBzBt>dN3V{g{7$!(ym>_{+f&_*M5*Q{( zV3;6*VS)sP2@)74NMM*CfnkCKh6xfFCP-kIAc0|m1jgJpoWsjFvd1`~oF@{yLjofY zL5^nd9m^q39PK)fHSWCJ!=A+1>OW$$YRo`ZGeAbCkkIg#iW?Tf(n~>OsF7D_h z)TiPcTm%_c$2U4x$I!Vt9_Qd9$hYeFVdv@?I#=KL2pY9*Uayb91?LuW+BUD*#*!vV zb8aTbjU^#^>(wb_pT0h + + + + + diff --git a/assets/icons/patreon.svg b/assets/icons/patreon.svg new file mode 100644 index 0000000..7f95628 --- /dev/null +++ b/assets/icons/patreon.svg @@ -0,0 +1,15 @@ + + + + + + diff --git a/assets/icons/rss.svg b/assets/icons/rss.svg new file mode 100644 index 0000000..f415fe2 --- /dev/null +++ b/assets/icons/rss.svg @@ -0,0 +1,72 @@ + + + + + + diff --git a/assets/icons/soundcloud.svg b/assets/icons/soundcloud.svg new file mode 100644 index 0000000..5d09394 --- /dev/null +++ b/assets/icons/soundcloud.svg @@ -0,0 +1,18 @@ + + + + + + diff --git a/assets/icons/spotify.svg b/assets/icons/spotify.svg new file mode 100644 index 0000000..e1998e5 --- /dev/null +++ b/assets/icons/spotify.svg @@ -0,0 +1,26 @@ + + + + + + diff --git a/assets/icons/tumblr.svg b/assets/icons/tumblr.svg new file mode 100644 index 0000000..5c07add --- /dev/null +++ b/assets/icons/tumblr.svg @@ -0,0 +1,22 @@ + + + + + + diff --git a/assets/icons/twitch.svg b/assets/icons/twitch.svg new file mode 100644 index 0000000..4394a10 --- /dev/null +++ b/assets/icons/twitch.svg @@ -0,0 +1,18 @@ + + + + + + diff --git a/assets/icons/twitter.svg b/assets/icons/twitter.svg new file mode 100644 index 0000000..6ee804c --- /dev/null +++ b/assets/icons/twitter.svg @@ -0,0 +1,39 @@ + + + + + + diff --git a/assets/icons/vimeo.svg b/assets/icons/vimeo.svg new file mode 100644 index 0000000..b954f14 --- /dev/null +++ b/assets/icons/vimeo.svg @@ -0,0 +1,26 @@ + + + + + + diff --git a/assets/icons/youtube.svg b/assets/icons/youtube.svg new file mode 100644 index 0000000..8953864 --- /dev/null +++ b/assets/icons/youtube.svg @@ -0,0 +1,29 @@ + + + + + + diff --git a/layouts/_default/home.html b/layouts/_default/home.html index 2a1ebd9..820a2f2 100644 --- a/layouts/_default/home.html +++ b/layouts/_default/home.html @@ -7,7 +7,7 @@ {{ if or (not (eq .Description "")) (not (eq .Title "")) -}}
- {{ with .Title }}

{{ . }}

{{ end }} + {{ with .Title }}

{{ . | markdownify }}

{{ end }} {{ with .Description }}

{{ . }}

{{ end }}
{{ with resources.GetMatch .Site.Params.headshotimg -}} diff --git a/layouts/_default/li-next.html b/layouts/_default/li-next.html index c2f0f43..ad7adf1 100644 --- a/layouts/_default/li-next.html +++ b/layouts/_default/li-next.html @@ -13,7 +13,7 @@ {{ end }}
-

{{ .Title }}

+

{{ .Title | markdownify }}

{{ if (isset .Params "description") }}{{ index .Params "description" | htmlUnescape }}{{ else }}{{ .Summary | plainify | htmlUnescape }}{{ end }}

Posted

diff --git a/layouts/_default/li.html b/layouts/_default/li.html index 9ffd735..10831a9 100644 --- a/layouts/_default/li.html +++ b/layouts/_default/li.html @@ -12,7 +12,7 @@
{{- end }}
-

{{ .Title }}

+

{{ .Title | markdownify }}

{{ if (isset .Params "description") }}{{ index .Params "description" | htmlUnescape }}{{ else }}{{ .Summary | plainify | htmlUnescape }}{{ end }}

Posted

diff --git a/layouts/_default/list.html b/layouts/_default/list.html index e082561..d945163 100644 --- a/layouts/_default/list.html +++ b/layouts/_default/list.html @@ -6,7 +6,7 @@
{{ if or (not (eq .Description "")) (not (eq .Title "")) -}}
- {{ with .Title }}

{{ . }}

{{ end }} + {{ with .Title | markdownify }}

{{ . }}

{{ end }} {{ with .Description }}

{{ . }}

{{ end }}
{{- end }} diff --git a/layouts/_default/single.html b/layouts/_default/single.html index 31280bb..5d32b80 100644 --- a/layouts/_default/single.html +++ b/layouts/_default/single.html @@ -6,7 +6,7 @@
-

{{ .Title }}

+

{{ .Title | markdownify }}

{{ if isset .Params "date" }}

Posted

{{ end }}
{{ with .Resources.GetMatch "featuredImage" -}} diff --git a/layouts/partials/footer.html b/layouts/partials/footer.html index 8244746..32211d1 100644 --- a/layouts/partials/footer.html +++ b/layouts/partials/footer.html @@ -1,21 +1,105 @@ \ No newline at end of file From 0d71200d8b52a5826f65af38cf2be6538dcca10d Mon Sep 17 00:00:00 2001 From: Joe Hutchinson Date: Wed, 9 Feb 2022 13:31:23 -0500 Subject: [PATCH 3/7] Fix spacing in README --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 66aea16..c500820 100644 --- a/README.md +++ b/README.md @@ -34,8 +34,8 @@ googleAnalytics = "Your google analytics tracking ID - optional" disqusShortname = "Your shortname for Disqus - optional" [params] - brand = "The name that is displayed in the top left of the website, consider it the website name" - description = "The website's description" + brand = "The name that is displayed in the top left of the website, consider it the website name" + description = "The website's description" facebook = "URL to your Facebook account - link will be included in the footer" flicker = "URL to your Flicker account - link will be included in the footer" github = "URL to your GitHub account - link will be included in the footer" @@ -49,9 +49,9 @@ disqusShortname = "Your shortname for Disqus - optional" twitter = "URL to your Twitter account - link will be included in the footer" vimeo = "URL to your Vimeo account - link will be included in the footer" youtube = "URL to your Youtube account - link will be included in the footer" - bgimg = "Path, within the 'assets' folder, of the image used for the page background - optional" - headshotimg = "Path, within the 'assets' folder, of the image used for the home page header - optional" - rssinmenu = whether you would like a RSS feed link to appear in the navigation menu and footer (true, false) - optional + bgimg = "Path, within the 'assets' folder, of the image used for the page background - optional" + headshotimg = "Path, within the 'assets' folder, of the image used for the home page header - optional" + rssinmenu = whether you would like a RSS feed link to appear in the navigation menu and footer (true, false) - optional [markup] [markup.highlight] From 80eedf87b4dd7a705b558eaa7f5d1772e48e6742 Mon Sep 17 00:00:00 2001 From: Joe Hutchinson Date: Wed, 9 Feb 2022 13:50:51 -0500 Subject: [PATCH 4/7] Clarify params in README and example site --- README.md | 32 ++++---- .../content/posts/aether-theme/index.md | 73 +++++++++++++------ 2 files changed, 67 insertions(+), 38 deletions(-) diff --git a/README.md b/README.md index c500820..95c1499 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ git clone https://github.com/josephhutch/aether.git themes/aether ### Website Configuration Customize the look and feel of aether through the config.toml file. See how to fill in the config file below. -``` +```toml baseURL = "https://yourwebsitenamegoeshere.com/" languageCode = "The language code for the language the website is written in" title = "The website title that is used in each page title, displayed in the browser tab and search results" @@ -34,24 +34,24 @@ googleAnalytics = "Your google analytics tracking ID - optional" disqusShortname = "Your shortname for Disqus - optional" [params] - brand = "The name that is displayed in the top left of the website, consider it the website name" + brand = "The name that is displayed in the top left of the website - optional, title is fallback" description = "The website's description" - facebook = "URL to your Facebook account - link will be included in the footer" - flicker = "URL to your Flicker account - link will be included in the footer" - github = "URL to your GitHub account - link will be included in the footer" - instagram = "URL to your Instagram account - link will be included in the footer" - linkedin = "URL to your LinkedIn account - link will be included in the footer" - patreon = "URL to your Patreon account - link will be included in the footer" - soundcloud = "URL to your Soundcloud account - link will be included in the footer" - spotify = "URL to your Spotify account - link will be included in the footer" - tumblr = "URL to your Tumblr account - link will be included in the footer" - twitch = "URL to your Twitch account - link will be included in the footer" - twitter = "URL to your Twitter account - link will be included in the footer" - vimeo = "URL to your Vimeo account - link will be included in the footer" - youtube = "URL to your Youtube account - link will be included in the footer" bgimg = "Path, within the 'assets' folder, of the image used for the page background - optional" headshotimg = "Path, within the 'assets' folder, of the image used for the home page header - optional" - rssinmenu = whether you would like a RSS feed link to appear in the navigation menu and footer (true, false) - optional + rssinmenu = whether you would like a RSS feed link to appear in the nav menu and footer (true, false) - optional + facebook = "URL to your Facebook account, icon link will be included in the footer - optional" + flicker = "URL to your Flicker account, icon link will be included in the footer - optional" + github = "URL to your GitHub account, icon link will be included in the footer - optional" + instagram = "URL to your Instagram account, icon link will be included in the footer - optional" + linkedin = "URL to your LinkedIn account, icon link will be included in the footer - optional" + patreon = "URL to your Patreon account, icon link will be included in the footer - optional" + soundcloud = "URL to your Soundcloud account, icon link will be included in the footer - optional" + spotify = "URL to your Spotify account, icon link will be included in the footer - optional" + tumblr = "URL to your Tumblr account, icon link will be included in the footer - optional" + twitch = "URL to your Twitch account, icon link will be included in the footer - optional" + twitter = "URL to your Twitter account, icon link will be included in the footer - optional" + vimeo = "URL to your Vimeo account, icon link will be included in the footer - optional" + youtube = "URL to your Youtube account, icon link will be included in the footer - optional" [markup] [markup.highlight] diff --git a/exampleSite/content/posts/aether-theme/index.md b/exampleSite/content/posts/aether-theme/index.md index 966ffb2..64a423b 100644 --- a/exampleSite/content/posts/aether-theme/index.md +++ b/exampleSite/content/posts/aether-theme/index.md @@ -32,54 +32,83 @@ git clone https://github.com/josephhutch/aether.git themes/aether Add the following parameters to your config file if they are not present already. ```toml -baseURL = "https://yourwebsitenamegoeshere.com" -languageCode = "your language code" -title = "your website title" +baseURL = "https://yourwebsitenamegoeshere.com/" +languageCode = "The language code for the language the website is written in" +title = "The website title that is used in each page title, displayed in the browser tab and search results" theme = "aether" -googleAnalytics = "Your google analytics tracking ID" +googleAnalytics = "Your google analytics tracking ID - optional" +disqusShortname = "Your shortname for Disqus - optional" [params] -brand = "the title displayed in the nav bar - optional" -description = "your website's description" -homeimg = "url to the image used for the home button - optional" -bgimg = "url to the image used for the background - optional" + brand = "The name that is displayed in the top left of the website - optional, title is fallback" + description = "The website's description" + bgimg = "Path, within the 'assets' folder, of the image used for the page background - optional" + headshotimg = "Path, within the 'assets' folder, of the image used for the home page header - optional" + rssinmenu = whether you would like a RSS feed link to appear in the nav menu and footer (true, false) - optional + facebook = "URL to your Facebook account, icon link will be included in the footer - optional" + flicker = "URL to your Flicker account, icon link will be included in the footer - optional" + github = "URL to your GitHub account, icon link will be included in the footer - optional" + instagram = "URL to your Instagram account, icon link will be included in the footer - optional" + linkedin = "URL to your LinkedIn account, icon link will be included in the footer - optional" + patreon = "URL to your Patreon account, icon link will be included in the footer - optional" + soundcloud = "URL to your Soundcloud account, icon link will be included in the footer - optional" + spotify = "URL to your Spotify account, icon link will be included in the footer - optional" + tumblr = "URL to your Tumblr account, icon link will be included in the footer - optional" + twitch = "URL to your Twitch account, icon link will be included in the footer - optional" + twitter = "URL to your Twitter account, icon link will be included in the footer - optional" + vimeo = "URL to your Vimeo account, icon link will be included in the footer - optional" + youtube = "URL to your Youtube account, icon link will be included in the footer - optional" + +[markup] + [markup.highlight] + style = "igor" ``` The `title` parameter is used for each page title, the title that search engines display in search results. If you would like the title shown in the top left of the page to be different from the page title, use the `brand` parameter. For instance, the title parameter for my site is `Joe Hutchinson` but the brand parameter is set to `joehutch`. -The `homeimg` and `bgimg` parameters give you the ability to customize the look of your site further. The homeimg parameter is the image used for the home button at the bottom of every page. Since the text used on the home button is white, a darker background image is preferred. If the homeimg parameter is not specified, a fallback image is used. Similarly, the bgimg parameter is used for the background of each webpage. Aether is designed to look best with a subtle tiling image for the background. If no background image is specified, the background will be a solid gray color. +Find your `language code` [here](https://www.metamodpro.com/browser-language-codes). + +The `bgimg` parameters give you the ability to customize the look of your site further. The homeimg should reside in the assets folder of your site. The homeimg parameter is the image used for the home button at the bottom of every page. Since the text used on the home button is white, a darker background image is preferred. If the homeimg parameter is not specified, a fallback image is used. Aether is designed to look best with a subtle tiling image for the background. If no background image is specified, the background will be a solid gray color. + +The default syntax highlighter `style` does not look great with aether so I recommend using igor. If you want to change the highlighter theme you can specify a different one from [this list](https://xyproto.github.io/splash/docs/all.html). To configure the syntax highlighter further, such as adding line numbers, check out [this Hugo doc section](https://gohugo.io/getting-started/configuration-markup#highlight). That is the only configuration required at the site level! You can now begin writing content for your site. ### Creating content Make a new blog post by executing `hugo new posts/postnamehere/index.md` in your shell. At the top of the new markdown file, is what's called the front matter. The front matter is the page's metadata that determines how Hugo and aether generate the HTML for your post. Below you can find what the front matter should contain for a new post and what each of the parameters mean. -```properties +```yaml --- -title: "The title of your post" -date: date the post was generated +title: "The title of the post" +date: date the post was generated (automatically generated) description: "Description of the post (displayed in the post's card)" -categories: ["add comma separated categories here", "another category"] -featuredImage: "url to the page's featured image" -featuredImageDescription: "Description for the featured image, used as the alt text" -dropCap: if the first letter should be a large decorative capital letter (true, false) -displayInMenu: if post is listed in the navigation menu (true, false) -displayInList: if post is listed on the home page and category pages (true, false) -draft: if the page is a draft (true, false) +categories: ["Add comma separated categories here", "another category"] +toc: if the post should include a table of contents (true, false) +displayInMenu: if the post should show up in the navigation menu (true, false) +displayInList: if the post should be listed on the home page and category pages (true, false) +draft: if the post is a draft (true, false) +resources: +- name: featuredImage + src: "Filename of the post's featured image, used as the card image and the image at the top of the article" + params: + description: "Description for the featured image, used as the alt text" + attribution: + name: "Name of person to attribute image to" + link: "optional URL to persons site" --- ``` The `displayInMenu` and `displayInList` parameters are used to determine where your content is displayed. Posts typically have displayInMenu set to false so that the post is not a menu option, and displayInList set to true so it shows up on the homepage's list of posts and in category page lists. An About Me page, on the other hand, would have displayInMenu set to true and displayInList set to false. That will allow the About Me page to be accessible from the menu but not displayed in the homepage's list of posts. -The `categories` parameter is used to group similar posts in category pages. Category pages are accessible from the menu and list all posts with the same category. +The `categories` parameter is used to group similar posts in category pages. Category pages are accessible from the menu and list all posts within the same category. The `dropCap` parameter is used to determine if the first letter of a post should be a dropped capital. A dropped capital letter is the large decorative letter at the beginning of a book or section. Add an interesting description and a good image to each post to get the most value from this theme. -Aether takes advantage of [page bundles](https://gohugo.io/content-management/page-bundles/) to optimize your images for your site. This may require you to update the way your content is structured, also see [content organization](https://gohugo.io/content-management/organization/). Use the `image` and `smallimg` shortcodes to take full advantage of image optimization. +Aether takes advantage of [page bundles](https://gohugo.io/content-management/page-bundles/) to optimize your images for your site. This may require you to update the way your content is structured, also see [content organization](https://gohugo.io/content-management/organization/). Use the `image` and `smallimg` shortcodes to take full advantage of image optimization. Also, the `featuredImage` resource must exist in the post's page bundle. -Posts are written in markdown and LaTeX (for math symbols and equations). You can find tons of information on how to format your posts with markdown and LaTeX on the web. +Posts are written in markdown. You can find how to write in markdown from this [markdown cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet). ### Further Customization To change the heading and subtext at the top of list pages just add a \_index.md file in the folder that the list page is generated from. For example to change the heading at the top of the homepage, add an \_index.md file to the content folder with the following parameters. From d49083abec1ff414a5140a9a01f0d21c88fc7f1c Mon Sep 17 00:00:00 2001 From: Joe Hutchinson Date: Wed, 9 Feb 2022 13:52:56 -0500 Subject: [PATCH 5/7] Fix how GitHub displays readme with TOML --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 95c1499..8e5b925 100644 --- a/README.md +++ b/README.md @@ -25,7 +25,7 @@ git clone https://github.com/josephhutch/aether.git themes/aether ### Website Configuration Customize the look and feel of aether through the config.toml file. See how to fill in the config file below. -```toml +``` baseURL = "https://yourwebsitenamegoeshere.com/" languageCode = "The language code for the language the website is written in" title = "The website title that is used in each page title, displayed in the browser tab and search results" From f7848361fc4c8963e4e094c1ce5ebe5f8a387a38 Mon Sep 17 00:00:00 2001 From: Joe Hutchinson Date: Thu, 10 Feb 2022 00:19:08 -0500 Subject: [PATCH 6/7] Mobile card active and GitHub Actions (#71) * Remove js for mobile card click style * Add headshot alt text and update example site * Add html validator github action * Debug GA * Fix GA bug --- .github/workflows/main.yml | 28 +++++++++++++++++++ README.md | 1 + assets/css/style.css | 3 +- exampleSite/config.toml | 1 + .../content/posts/aether-features/index.md | 2 ++ .../posts/creating-a-new-theme/index.md | 2 ++ .../content/posts/goisforlovers/index.md | 11 ++++---- .../content/posts/hugoisforlovers/index.md | 9 ++++-- .../posts/migrate-from-jekyll/index.md | 2 ++ layouts/_default/home.html | 2 +- layouts/_default/li-next.html | 5 ++-- layouts/_default/li.html | 3 +- layouts/partials/home-card.html | 2 +- 13 files changed, 54 insertions(+), 17 deletions(-) create mode 100644 .github/workflows/main.yml diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml new file mode 100644 index 0000000..7c85603 --- /dev/null +++ b/.github/workflows/main.yml @@ -0,0 +1,28 @@ +name: Validate Generated Files + +on: + push: + branches: + - master + pull_request: + branches: + - master + +jobs: + deploy: + runs-on: ubuntu-20.04 + steps: + - uses: actions/checkout@v2 + + - name: Install Dependencies + run: | + sudo snap install hugo + pip install html5validator + + - name: Build Example Site + run: | + cd exampleSite/ + hugo --minify + + - name: Validate Generated Files + run: html5validator --root exampleSite/public/ --also-check-css --ignore katex diff --git a/README.md b/README.md index 8e5b925..7016d30 100644 --- a/README.md +++ b/README.md @@ -38,6 +38,7 @@ disqusShortname = "Your shortname for Disqus - optional" description = "The website's description" bgimg = "Path, within the 'assets' folder, of the image used for the page background - optional" headshotimg = "Path, within the 'assets' folder, of the image used for the home page header - optional" + headshotalt = "Alt text for the headshotimg - should be used with headshotimg" rssinmenu = whether you would like a RSS feed link to appear in the nav menu and footer (true, false) - optional facebook = "URL to your Facebook account, icon link will be included in the footer - optional" flicker = "URL to your Flicker account, icon link will be included in the footer - optional" diff --git a/assets/css/style.css b/assets/css/style.css index 1c62f08..b6e8c81 100644 --- a/assets/css/style.css +++ b/assets/css/style.css @@ -10,7 +10,6 @@ body { align-items: center; width: 100%; box-sizing: border-box; - word-break: break-word; } p { margin: 1.5em 0; @@ -458,7 +457,7 @@ footer { margin: 0; } @media screen and (pointer: coarse) { - .card-hover { + .card:active { transform: scale(0.95); box-shadow: 0 0.4rem 2rem 0 rgba(0,0,0,0.2); } diff --git a/exampleSite/config.toml b/exampleSite/config.toml index d286c3c..af88763 100644 --- a/exampleSite/config.toml +++ b/exampleSite/config.toml @@ -10,6 +10,7 @@ themesDir = "../../" brand = "aether" description = "aether Hugo theme for blogs" headshotimg = "img/faceshot.jpg" + headshotalt = "Generic grey headshot picture" [markup] [markup.highlight] diff --git a/exampleSite/content/posts/aether-features/index.md b/exampleSite/content/posts/aether-features/index.md index c29d9bc..22987d3 100644 --- a/exampleSite/content/posts/aether-features/index.md +++ b/exampleSite/content/posts/aether-features/index.md @@ -10,6 +10,8 @@ draft: false resources: - name: featuredImage src: "mdd-iphone.jpg" + params: + description: "An iphone with a website featuring the aether theme" --- Hugo combined with the Aether theme turns easy to write markdown into powerful web pages. KaTeX, Highlight.js, and Hugo provides the ability to create mathmatical symobols, equations, highlighted code, tables, lists, and much more. diff --git a/exampleSite/content/posts/creating-a-new-theme/index.md b/exampleSite/content/posts/creating-a-new-theme/index.md index 8159821..f296d6e 100644 --- a/exampleSite/content/posts/creating-a-new-theme/index.md +++ b/exampleSite/content/posts/creating-a-new-theme/index.md @@ -9,6 +9,8 @@ draft: false resources: - name: featuredImage src: "nyc.jpg" + params: + description: "The New York City skyline" --- diff --git a/exampleSite/content/posts/goisforlovers/index.md b/exampleSite/content/posts/goisforlovers/index.md index f581909..2f24361 100644 --- a/exampleSite/content/posts/goisforlovers/index.md +++ b/exampleSite/content/posts/goisforlovers/index.md @@ -15,11 +15,12 @@ categories = [ "Development", "golang", ] -[[resources]] - name = "featuredImage" - src = "lucas-benjamin-565254-unsplash.jpg" - [resources.params] - description = "Alt description for the featured image" +[resources] +name = "featuredImage" +src = "lucas-benjamin-565254-unsplash.jpg" + +[resources.params] +description = "A jellyfish with neon colors with a dark background" +++ Hugo uses the excellent [Go][] [html/template][gohtmltemplate] library for diff --git a/exampleSite/content/posts/hugoisforlovers/index.md b/exampleSite/content/posts/hugoisforlovers/index.md index 52ebf7d..877edc4 100644 --- a/exampleSite/content/posts/hugoisforlovers/index.md +++ b/exampleSite/content/posts/hugoisforlovers/index.md @@ -15,9 +15,12 @@ categories = [ "Development", "golang", ] -[[resources]] - name = "featuredImage" - src = "andrew-neel-609846-unsplash.jpg" +[resources] +name = "featuredImage" +src = "andrew-neel-609846-unsplash.jpg" + +[resources.params] +description = "A person sitting on a hardwood floor on their laptop" +++ ## Step 1. Install Hugo diff --git a/exampleSite/content/posts/migrate-from-jekyll/index.md b/exampleSite/content/posts/migrate-from-jekyll/index.md index 7b323ab..7086cf1 100644 --- a/exampleSite/content/posts/migrate-from-jekyll/index.md +++ b/exampleSite/content/posts/migrate-from-jekyll/index.md @@ -7,6 +7,8 @@ title: Migrate to Hugo from Jekyll resources: - name: featuredImage src: "yan-ots-257617-unsplash.jpg" + params: + description: "Colorful buildings alongside a body of water" --- ## Move static content to `static` diff --git a/layouts/_default/home.html b/layouts/_default/home.html index 820a2f2..7ec6bb8 100644 --- a/layouts/_default/home.html +++ b/layouts/_default/home.html @@ -17,7 +17,7 @@ {{ $faceshot_x2 := .Resize "544x Lanczos" }} {{ $faceshot_x3 := .Resize "816x Lanczos" }} - {{ . }} + {{ . }}
{{ end -}} diff --git a/layouts/_default/li-next.html b/layouts/_default/li-next.html index ad7adf1..ced83df 100644 --- a/layouts/_default/li-next.html +++ b/layouts/_default/li-next.html @@ -1,5 +1,4 @@ - + {{ with .Resources.GetMatch "featuredImage" }}

Next Article

@@ -16,7 +15,7 @@

{{ .Title | markdownify }}

{{ if (isset .Params "description") }}{{ index .Params "description" | htmlUnescape }}{{ else }}{{ .Summary | plainify | htmlUnescape }}{{ end }}

-

Posted

+

Posted

{{ if (isset .Params "categories") }}

{{ range .Params.categories }}#{{ . }} {{ end }}

{{ end }}
diff --git a/layouts/_default/li.html b/layouts/_default/li.html index 10831a9..4cdb678 100644 --- a/layouts/_default/li.html +++ b/layouts/_default/li.html @@ -1,5 +1,4 @@ - + {{ with .Resources.GetMatch "featuredImage" }}
diff --git a/layouts/partials/home-card.html b/layouts/partials/home-card.html index 7435a58..504e4ca 100644 --- a/layouts/partials/home-card.html +++ b/layouts/partials/home-card.html @@ -1,4 +1,4 @@ - Home \ No newline at end of file From 99cddb52cc9353cb02d8badb2c53b2abcd41a494 Mon Sep 17 00:00:00 2001 From: Joe Hutchinson Date: Thu, 10 Feb 2022 00:24:16 -0500 Subject: [PATCH 7/7] Update README.md --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 7016d30..9d8cabd 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,7 @@ # aether + +[![Validate Generated Files](https://github.com/josephhutch/aether/actions/workflows/main.yml/badge.svg)](https://github.com/josephhutch/aether/actions/workflows/main.yml) + Aether is a Hugo theme for blogs that emphasizes motion, depth, and material as design elements. Aether presents your content in a clean interface that highlights good photography and writing. ## Features @@ -172,7 +175,7 @@ Refer to [/exampleSite/layouts/partials](/exampleSite/layouts/partials) for samp [Latex Math Documentation](https://en.wikibooks.org/wiki/LaTeX/Mathematics) - Learn math typesetting with LaTeX (powered by KaTeX) ## Contributing -Aether is actively maintained and I welcome you to help make it better! Contributions in the way of new features, documentation improvements, bug fixes, and feature requests are appreciated. Please make an individual pull-request/issue for each suggestion. +Aether is actively maintained and I welcome you to help make it better! Contributions in the way of new features, documentation improvements, bug fixes, and feature requests are appreciated. Please make an individual pull-request/issue for each suggestion. PRs are tested in GitHub Actions to ensure the html and css generated from the example site are valid. ## License MIT © Joe Hutchinson