This commit is contained in:
Zachary Betz 2019-02-08 15:49:18 -06:00
parent dc06f040ec
commit ac614e6ab5
6 changed files with 34 additions and 76 deletions

View File

@ -5,10 +5,9 @@ theme = "cupper-hugo-theme"
googleAnalytics = "UA-123456789-1"
# Uncomment below to enable syntax highlighting
# pygmentsCodefences = true
# pygmentsCodefencesGuessSyntax = true
# For more styles see https://xyproto.github.io/splash/docs/all.html
# pygmentsStyle = "pygments"
# pygmentsCodefences = true
# pygmentsStyle = "algol"
[taxonomies]
tag = "tags"
@ -17,32 +16,30 @@ googleAnalytics = "UA-123456789-1"
post = "/:filename/"
[menu]
[[menu.main]]
[[menu.nav]]
name = "Home"
url = "/"
weight = 1
[[menu.main]]
[[menu.nav]]
name = "Blog"
url = "/post/"
weight = 2
[[menu.main]]
[[menu.nav]]
name = "Tags"
url = "/tags/"
weight = 3
[[menu.main]]
[[menu.nav]]
name = "About"
url = "/about/"
weight = 4
[[menu.main]]
[[menu.nav]]
name = "RSS"
url = "/index.xml"
weight = 5
[params]
description = "Documentation for the **Cupper** documentation builder, built with **Cupper** itself."
footerText = "Made with [Hugo](https://gohugo.io/) & TODO"
hideFooter = false
# Keep?
codePenUser = "Heydon"
# TODO link to date format docs page
# description = "An accessibility-friendly Hugo theme, ported from the [original Cupper](https://github.com/ThePacielloGroup/cupper) project."
footer = "Made with [Hugo](https://gohugo.io/). Themed by [Cupper](https://github.com/zwbetz-gh/cupper-hugo-theme). Deployed to [Netlify](https://www.netlify.com/)."
# For more date formats see https://gohugo.io/functions/format/
dateFormat = "Jan 2, 2006"
codePenUser = "TODO"

View File

@ -1,18 +1,12 @@
+++
date = "2017-06-26T18:27:58+01:00"
title = "The Cupper Documentation Builder"
title = "Home"
+++
Welcome to **Cupper**: a documentation builder for inclusive designers and those trying to be inclusive designers. These are **Cupper's** docs, but they are also an example of a site built with **Cupper**. Here are some of its features:
Welcome to **Cupper**: An accessibility-friendly Hugo theme, ported from the [original Cupper](https://github.com/ThePacielloGroup/cupper) project. Here are some of its features:
{{% ticks %}}
* Built with [Hugo](https://gohugo.io/), so easy to structure content and fast to compile it
* Available to read offline, as a [Progressive Web App](https://developers.google.com/web/progressive-web-apps/)
* Include encapsulated live demos, inline with your markdown, [using Shadow DOM](https://www.smashingmagazine.com/2017/07/pattern-libraries-in-markdown/)
* Quickly include WCAG and [Inclusive Design Principles](http://inclusivedesignprinciples.org/) references
* A responsive, screen reader and keyboard accessible static site as output
* Automated Github Pages deployment
* Includes a single-page printable version suitable for PDF conversion
* Responsive
* Screen reader and keyboard accessible
* TODO
{{% /ticks %}}
To get started, take a look at {{% pattern "Installation" %}}.

View File

@ -38,11 +38,9 @@
{{ end }}
</head>
<body>
{{ if ne .Type "print-version" }}
<a href="#main">skip to content</a>
{{ end }}
{{ partial "svg.html" . }}
<div class="wrapper {{ if eq .Type "print-version" }}print-version{{ end }}">
<div class="wrapper">
<header class="intro-and-nav" role="banner">
<div>
<div class="intro">
@ -51,21 +49,8 @@
</a>
<p class="library-desc">
{{ .Site.Params.Description | markdownify }}
{{ if ne .Type "print-version" }}
<a class="print" href="{{ "print-version" | absURL }}">
<svg viewBox="0 0 35 45" aria-hidden="true" focusable="false">
<use xlink:href="#doc"></use>
</svg>Print version
{{ end }}
</a>
</p>
{{ if eq .Type "print-version" }}
<p class="toc-link">
<span aria-hidden="true">&#x2193;</span>
<a href="#toc">Table of contents</a>
<span aria-hidden="true">&#x2193;</span>
</p>
{{ end }}
</div>
{{ block "nav" . }}
<nav id="patterns-nav" class="patterns" role="navigation">
@ -77,37 +62,20 @@
Menu
</button>
{{ $current := . }}
{{ range $.Site.Home.Sections }}
<ul id="patterns-list">
{{ range .Pages.ByWeight }}
{{ range .Site.Menus.nav }}
<li class="pattern">
<a href="{{ .RelPermalink }}" {{ if eq $current.Permalink .Permalink }}aria-current="page"{{ end }}>
{{ $active := or ($current.IsMenuCurrent "nav" .) ($current.HasMenuCurrent "nav" .) }}
{{/* TODO highlight Blog nav item when on post pages */}}
<a href="{{ .URL }}" {{ if $active }}aria-current="page"{{ end }}>
<svg class="bookmark-icon" aria-hidden="true" focusable="false" viewBox="0 0 40 50">
<use xlink:href="#bookmark"></use>
</svg>
<span class="text">{{ .Title }}</span>
</a>
</li>
{{ end }}
{{ range .Sections.ByWeight }}
<li>
<h3>{{ .Title }}</h3>
<ul>
{{ range .Pages.ByWeight }}
<li class="pattern">
<a href="{{ .RelPermalink }}" {{ if eq $current.Title .Title }}aria-current="page"{{ end }}>
<svg class="bookmark-icon" aria-hidden="true" viewBox="0 0 40 50" focusable="false">
<use xlink:href="#bookmark"></use>
</svg>
<span class="text">{{ .Title }}</span>
<span class="text">{{ .Name }}</span>
</a>
</li>
{{ end }}
</ul>
</li>
{{ end }}
</ul>
{{ end }}
</nav>
{{ end }}
</div>
@ -123,8 +91,7 @@
<span aria-hidden="true"></span>
</label>
</div>
Powered by <strong>Cupper</strong>, a <strong>The Paciello Group</strong> project.<br>
For general enquiries, contact us on info@paciellogroup.com.
{{ .Site.Params.footer | markdownify }}
</footer>
</div>
</div>