From 6bd6e2104ced2f803a9aa1c06d2a0046367df147 Mon Sep 17 00:00:00 2001 From: James Panther <4462786+jpanther@users.noreply.github.com> Date: Mon, 24 Jan 2022 09:05:56 +1100 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Add=20first=20pass=20at=20v2=20d?= =?UTF-8?q?ocumentation?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 16 +- exampleSite/content/_index.md | 8 +- exampleSite/content/docs/version-2/_index.md | 92 + .../content/docs/version-2/image-resizing.png | Bin 0 -> 253342 bytes .../content/docs/version-2/lighthouse.html | 11700 ++++++++++++++++ .../content/docs/version-2/lighthouse.jpg | Bin 0 -> 64698 bytes .../content/docs/version-2/upgrade/index.md | 177 + 7 files changed, 11981 insertions(+), 12 deletions(-) create mode 100644 exampleSite/content/docs/version-2/_index.md create mode 100644 exampleSite/content/docs/version-2/image-resizing.png create mode 100644 exampleSite/content/docs/version-2/lighthouse.html create mode 100644 exampleSite/content/docs/version-2/lighthouse.jpg create mode 100644 exampleSite/content/docs/version-2/upgrade/index.md diff --git a/README.md b/README.md index f601bd7..27440ae 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Congo -Congo is designed to be a simple, lightweight theme for [Hugo](https://gohugo.io). It's built using Tailwind CSS with a clean and minimalist design that prioritises to your content. +Congo is designed to be a powerful, lightweight theme for [Hugo](https://gohugo.io). It's built using Tailwind CSS with a clean and minimalist design that prioritises to your content. 🌏 [Demo site](https://jpanther.github.io/congo/) 📑 [Theme documentation](https://jpanther.github.io/congo/docs/) @@ -11,7 +11,7 @@ Congo is designed to be a simple, lightweight theme for [Hugo](https://gohugo.io ## Features -- Fully responsive layout built with Tailwind CSS v3 +- Fully responsive layout built with Tailwind CSS 3.0 - Multiple colour schemes (or fully customise your own) - Dark mode (forced on/off or auto-switching with user toggle) - Highly customisable configuration @@ -19,20 +19,20 @@ Congo is designed to be a simple, lightweight theme for [Hugo](https://gohugo.io - Flexible with any content types, taxonomies and menus - Multilingual content support inlcuding support for RTL languages - Ability to link to posts on third-party websites +- Client-side site search powered by Fuse.js - Diagrams and visualisations using Mermaid - Charts using Chart.js - Mathematical notation using KaTeX - SVG icons from FontAwesome 5 -- Heading anchors, Buttons, Badges and more +- Automatic image resizing using Hugo Pipes +- Heading anchors, Tables of Contents, Buttons, Badges and more - HTML and Emoji support in articles 🎉 - SEO friendly with links for sharing to social media -- RSS feeds - Fathom Analytics and Google Analytics support -- Favicons support -- Comments support +- RSS feeds, Favicons and comments support - Advanced customisation using simple Tailwind colour definitions and styles -- Fully documented -- Regular updates with fixes and new features +- Optimised for performance and accessibility with perfect Lighthouse scores +- Fully documented with regular updates --- diff --git a/exampleSite/content/_index.md b/exampleSite/content/_index.md index ddb0092..8915970 100755 --- a/exampleSite/content/_index.md +++ b/exampleSite/content/_index.md @@ -4,15 +4,17 @@ description: "This is a demo of the Congo theme for Hugo." --- {{< lead >}} -A simple, lightweight theme for Hugo built with Tailwind CSS. +A powerful, lightweight theme for Hugo built with Tailwind CSS. {{< /lead >}} +This is a demo site built entirely using Congo. It also contains a complete set of [theme documentation]({{< ref "docs" >}}). Congo is flexible and is great for both static page-based content (like this demo) or a traditional blog with a feed of recent posts. +
page layout.
+ This is a demo of the page layout.
+```
+
+Best of all there's nothing you need to change! Simply insert standard Markdown image syntax and let the theme do the rest. If you want a little more control, the `figure` shortcode has been completely rewritten to provide the same resizing benefits.
+
+## Performance improvements
+
+This update packs performance improvements throughout. A key objective for this release was to improve Lighthouse scores and Congo now scores a perfect 100 on all four metrics.
+
+{{< screenshot src="lighthouse.jpg" >}}
+
+There's too many individual changes to highlight them here but the results speak for themselves. If you want to dig deeper, you can [view the Lighthouse report](lighthouse.html). Real world performance will vary based upon server configuration.
+
+## Site search
+
+Powered by [Fuse.js](https://fusejs.io), site search allows visitors to quickly and easily find your content. All searches are performed client-side meaning there's nothing to configure on the server and queries are performed super fast. Simply enable the feature in your site configuration and you're all set. Oh, and it also supports full keyboard navigation!
+
+## Tables of contents
+
+A highly requested feature, Congo now supports tables of contents on article pages. You can see it in action on this page. The contents are fully responsive and will adjust to take advantage of the space available at different screen resolutions.
+
+Available on a global or per article basis, the table of contents can be fully customised using standard Hugo configuration values, allowing you to adjust the behaviour to suit your project.
+
+## Accessibility improvements
+
+From adding ARIA descriptions to more items or simply adjusting the contrast of certain text elements, this release is the most accessible yet.
+
+Version 2 also introduces "skip to content" and "scroll to top" links that enable quick navigation. There's also keyboard shortcuts for enabling items like search without reaching for the mouse.
+
+The new image resizing features also provide full control over `alt` and `title` elements enabling an accessible experience for all visitors.
+
+## A whole lot more
+
+There's countless other minor changes to explore. From being able to display taxonomies on articles and list pages, to using the new `headline` author parameter to customise your homepage. There's also improved JSON-LD strucured data which further optimises SEO performance. Plus the entire theme has had extra polish to ensure a consistent design language.
+
+If you're ready to upgrade, read the [upgrading from version 1 guide]({{< ref "upgrade" >}}) to get started. If you're new to Congo, check out the [Installation guide]({{< ref "docs/installation" >}}) to begin a new project.
+
+---
diff --git a/exampleSite/content/docs/version-2/image-resizing.png b/exampleSite/content/docs/version-2/image-resizing.png
new file mode 100644
index 0000000000000000000000000000000000000000..396f2faee2fc51af698fff834f317867e9fbe4af
GIT binary patch
literal 253342
zcmeFZX&{wd)Hi;aDnlumDH54yW#|YQGDPN7hJ%E=%=3KGjUtpxMWzfTqNt2@WV)je
z6-tPZA!IC)cU|Xl+{5!e|4;vq@A*(?*n91@*Z5m&@5>cKgJaw2IOz}s*{-9lVT>R<
z4gxdQQ@
zZ>PJS+{MebprM2OVi#$ohWA7@mXZA6LEJeeulEm6tRFhJ*XxF3+6$B=^6RTIHqx5K
zK}k1^ZI|ifT|r3~7Oxw>B}6PfxR8gz|0~+k6!2fE7f;eI)A>JmC09c}u(AjV|6@qj
zN#@$HOLx&P=UxF7&ioRI#>6PiSb$aC%+^|5%ss0NX}zO3v|P&S$jTcX^3j5A(lV
zsrxY@JWt^tG{5p;49W|)cr+yb5@w&1X{{U3qV=rL27C)_;t&%1K2(`6tKI(OT;b
zr&$Wp(EQ_P@5^>51A{uuOjGIMlt|WgzZxB}W75MbDxBS6q0tVntkygpOANcprihTI
zsjdq_6h@F|+WYGIg@q7gheyHvmMsUI&)^J;-|d<4Ke67Ye%$Bj%>ozOI^499UNw0p
z(qV<^w7rnWy83c}XzV3_Hm{LvWdt9!TsdDZzVGg6`R5a3M_gj)3KPP)s;S5`JH)Yx
z>qaUKzDY~V5>>(0i_ f%
zKa9lVqdiTGmvot8@3+vp+Ns2CpsjCrNZEq(nxnG>$uWL)H#*Gm24%jQPzLRxpk6LH
zQ{W9}!Lx3X?GgT_|LuVWUJ^FuD$*jiRI4gl8(mwu6Emdpm<^vUMtwT#BR~(k%4Cf(
zt8O$uGqj4G jf{TWRQ;(6m{Oe;-yXR01_%8dh_ruckf^Nl1-D|*Q^SQYQVXG+GYYyY5c=a-DPORq=fXmd4IA$RYHMA9V
zvc%s0lr2cRH|H4fwGff+o7buu+~6WUg5qf~E!xwZ^G6ClLGh<>`?=K<(5#=>x(lsD
z5#j_X3OBFrZrR@_x1ddDoGOenz(|G=sf0$&}XT!Qq%T0?{n>
zqDhq&8ved59r$g4^RVA0<~`6G>%|O*k|$yxuTvvgvA&aQvqDK<@
d
zH+g6ZWa1)8i`5jG?E}cfF|q=DjZ+r>yA;U9b{DNo>915QaQRGfX{?3-+`%6Q(U7{d
z
((b4)sjO75rYnS;w?=Z|9J*qmP8Xyzr|3*LNOA9D0@G3hHIM&wN4Si--JFb0?Ww~;ozj1D4v
zT;*;Ea?iKmZTGWPyQZ$smc|i%Jn>WmND6mES2I-U`vt5hF>jp8cgCN
rMi8TLB-^>r<14$9vzt@D0HezF0&lKAKb_tB*XUL(q?Cg)~
z^3|E}Hoo3i8!fR@tr5L9isBCyOAOxC22V^6lbFCO-TIAvV^K1P5%$xUg(8HkpqGyK
zKCOhSu3nBjd1;$i#J#7Adi5FIKU|zSIfC?picuBzfRGfZn}l_1w|&G8)z@HxU#3`H
zS}HYY3uWC4maA}>K0eq|(NtWo=McKNwzhUAdB_dUcKh3qopw2jnKyt!#gJW8Nx0)-
z%fX}We*)}}0%YTsrNJwv^qSwl{@QP4IGy9J63BNw@)z%&k01Km10d0ip1X>Mq&0$6
zqZ6#Nw&3xysXHY!DT_={mzUAPOn*^mzvb8m*gt{&T3mLQ!+|LKF1=)|B*yZRBu>YqQS<2U&2j{jVBd+2@)&LGol(F7&O
z|5_+T=5yoZ&r@T;jK!Z4u?Nna%?qh@AU6JD`bsibVVUqjJMIaLQolSsUFtu(8PyHJ
zz0y8!+lH7u8fT$5dthvdikbMydhQyGx5-2P^G$&CP&y07$Y(5mZ%M=nT^RyHe2EEf
z^n8fPK=*Gh;FpfnV0|^b3{D`VcRw^TG69$nuk+%2K`w%Y4#9MrJovvI!r5f6L3$J7U=0atW5SeP02eQ8eZ
zqQk4ebr$Gmlc*SJ1k70r=Wu~aQev@{vZqVC=E@Do@v9+{)u=u;T>Ab+>k~8y!%HXQ
zTN`^tXL`rIyW+QcxuP=mo|n6K8BCX4H}msmqVeHiU;6?cM70>*Ds0BtnQaK1rziCm
zXXxBZuM2ZBC;~+uYI1;IQTj}#f>HDG=+^<`amv%qHuhJ?<34IpI!N3T4x$*^ed4n3
z7qoHJ+~NMAQ#rVK0o80i)kqekL?bhzwfR`%0_*8xe3(fcO+JHTJ(eXHM3VEVr8(G8
zpf|EXyDM*_GJ(C(e=Mlh(8^OY;K{4?9v-z*#N&
vN77B_kj
z#oTA#X(haOai>mWF?a(d#l`htf%N8D%3xnIkZZ&C3}{G14?AW!bhv|d2bf9fm){N#
zPto^6