Redesign

shortbread-website/README.md

@@ -0,0 +1,20 @@
+# Shortbread website
+
+The website is created using [Hugo](https://gohugo.io/).
+
+## Theme
+
+The theme is based on [Hextra](https://imfing.github.io/hextra/docs/).
+
+## Development
+
+```
+hugo serve
+```
+
+Update theme:
+
+```
+git remote add hextra [email protected]:pka/hextra.git
+git subtree pull --prefix=shortbread-website/themes/hextra hextra backport-debian --squash
+```

shortbread-website/assets/css/custom.css

@@ -0,0 +1,114 @@
+@font-face {
+    font-family: "Lato";
+    src: url("/fonts/Lato/Lato-Regular.ttf") format("truetype");
+    font-weight: 400;
+    font-style: normal;
+}
+
+@font-face {
+    font-family: "Lato";
+    src: url("/fonts/Lato/Lato-Italic.ttf") format("truetype");
+    font-weight: 400;
+    font-style: italic;
+}
+
+@font-face {
+    font-family: "League Gothic";
+    src: url("/fonts/League_Gothic/LeagueGothic-Regular-VariableFont_wdth.ttf")
+        format("truetype");
+    font-optical-sizing: auto;
+    font-weight: 400;
+    font-style: normal;
+    font-variation-settings: "wdth" 100;
+}
+
+:root {
+    font-family: "Lato", sans-serif;
+    font-size: 1.1rem;
+    --primary-hue: 48deg;
+    --primary-saturation: 93%;
+}
+
+body {
+    background-color: rgb(255 248 219);
+}
+
+/*  Title bar */
+.nav-container-blur {
+    background-color: hsl(48deg 93% 45% / 1);
+}
+.nav-container .hx-font-extrabold {
+    font-family: "League Gothic", sans-serif;
+    font-size: 1.55em;
+    font-weight: 400;
+}
+
+/* Menu hover background */
+aside.sidebar-container .hover\:hx-bg-gray-100:hover {
+    background-color: hsl(48deg 93% 85% / 1);
+}
+
+/* background for theme switcher */
+html:not(.dark) aside.sidebar-container .hx-sticky {
+    background-color: rgb(255 248 219);
+    --tw-shadow: none;
+}
+
+/* background for "Edit this page" */
+nav .hx-bg-white {
+    background-color: rgb(255 248 219);
+    --tw-shadow: none;
+}
+
+.content h1,
+h2,
+h3 {
+    font-family: "League Gothic", sans-serif;
+}
+
+.content h1 {
+    font-size: 3.77em;
+    font-weight: 400;
+    letter-spacing: normal;
+}
+.content h2 {
+    font-size: 2.11em;
+    font-weight: 400;
+    letter-spacing: normal;
+}
+.content h3 {
+    font-size: 1.55em;
+    font-weight: 400;
+    letter-spacing: normal;
+}
+
+/* Table rows */
+.content
+    :where(table):not(
+        :where(
+                .hextra-code-block table,
+                [class~="not-prose"],
+                [class~="not-prose"] *
+            )
+    )
+    tr:nth-child(2n) {
+    background-color: hsl(48deg 93% 39% / 0.05);
+}
+
+.example-images img {
+    display: initial;
+    width: 300px;
+}
+
+html:not(.dark) footer.hextra-footer.hx-bg-gray-100 {
+    background-color: hsl(48deg 93% 45% / 1);
+}
+
+/* Reduce footer height */
+footer .hx-py-12 {
+    padding-top: 1rem;
+    padding-bottom: 1rem;
+}
+footer .hx-mt-6 {
+    margin-top: 0;
+}

shortbread-website/config.toml

@@ -1,22 +1,72 @@
-baseURL = ""
-languageCode = "en-us"
+baseURL = "https://shortbread-tiles.org/"
 title = "Shortbread"
-theme = "hugo-theme-docdock"
-pygmentsCodeFences = true
-pygmentsStyle = "monokailight"
-
-defaultContentLanguage = "en"
-defaultContentLanguageInSubdir= false
-enableMissingTranslationPlaceholders = false
+theme = "hextra"
 enableRobotsTXT = false
+enableGitInfo = true
+enableInlineShortcodes = true
+
+[outputs]
+home = [ "HTML" ]
+page = [ "HTML" ]
+section = [ "HTML", "RSS" ]
+
+[languages.en]
+languageName = "English"
+weight = 1
+title = "Shortbread"
+
+[markup.goldmark.renderer]
+unsafe = true
+
+[markup.highlight]
+noClasses = false
+
+[[menu.main]]
+name = "Search"
+weight = 5
+
+  [menu.main.params]
+  type = "search"
 
 [params]
-ordersectionsby = "weight"
 description = "A free & simple Vector Tile schema for OpenStreetMap"
+displayUpdatedDate = false
+dateFormat = "January 2, 2006"
 
-[outputs]
-home = [ "HTML", "RSS", "JSON" ]
+  [params.navbar]
+  displayTitle = true
+  displayLogo = true
+  width = "normal"
 
-[markup.goldmark.renderer]
-unsafe = true # Allow HTML in Markdown
+    [params.navbar.logo]
+    path = "/shortbread_logo.svg"
+    dark = "/shortbread_logo.svg"
+
+  [params.page]
+  width = "normal"
+
+  [params.theme]
+  default = "light"
+  displayToggle = false
+
+  [params.footer]
+  enable = true
+  displayCopyright = true
+  displayPoweredBy = false
+  width = "normal"
+
+  [params.search]
+  enable = true
+  type = "flexsearch"
+
+    [params.search.flexsearch]
+    index = "content"
+    tokenize = "forward"
+
+  [params.editURL]
+  enable = true
+  base = "https://github.com/shortbread-tiles/shortbread-docs/edit/main/shortbread-website/content"
 
+[params.highlight.copy]
+enable = true
+display = "hover"

shortbread-website/content/_index.md

@@ -1,4 +1,9 @@
-# Shortbread Tiles
++++
+title = "Shortbread Tiles"
+toc = false
+cascade.breadcrumbs = false
+cascade.type = "docs"
++++
 
 ## About
 

shortbread-website/content/copyright/_index.md

@@ -1,10 +1,9 @@
 +++
 title = "Copyright & License"
+toc = false
 weight = 1
 +++
 
-# Copyright
-
 We take the position that this schema is not creative enough to be a copyrightable
 work.
 

shortbread-website/content/imprint.md

@@ -1,7 +1,8 @@
----
----
-
-# Imprint
++++
+title = "Imprint"
+toc = false
+sidebar.exclude = true
++++
 
 This web site is run by
 

shortbread-website/content/publishing/_index.md

@@ -1,7 +1,7 @@
 +++
 title = "Publishing Shortbread Maps"
 description = "Publishing maps with Shortbread vector tiles"
-weight = 6
+weight = 7
 +++
 
 ## Required resources for Shortbread maps

shortbread-website/content/schema/1.0.md

@@ -2,9 +2,9 @@
 title = "Vector Tile Schema 1.0"
 linkTitle = "1.0"
 description = "This page describes the layers of the Shortbread vector schema and their contents as of version 1.0"
+toc = true
 +++
 
-{{% toc /%}}
 
 ## About
 

shortbread-website/content/schema/versioning.md

@@ -1,5 +1,4 @@
 +++
-draft= false
 title = "Schema Versioning Policy"
 linkTitle = "Versioning"
 description = "This page describes the versioning policy of the Shortbread schema"

shortbread-website/content/styles/_index.md

@@ -2,7 +2,6 @@
 title = "Map Styles"
 description = "This page gives an overview about available open source maps styles for Shortbread vector tiles"
 weight = 3
-toc = false
 +++
 
 ## Web mapping libraries

shortbread-website/i18n/en.yaml

@@ -0,0 +1 @@
+copyright: "[Imprint](/imprint) | Map data by [OpenStreetMap contributors](https://www.openstreetmap.org/copyright) published under Open Database License"

shortbread-website/static/favicon-dark.svg

@@ -0,0 +1 @@
+shortbread_logo.svg

shortbread-website/static/favicon.svg

@@ -0,0 +1 @@
+shortbread_logo.svg

shortbread-website/static/fonts/Lato/OFL.txt

@@ -0,0 +1,93 @@
+Copyright (c) 2010-2014 by tyPoland Lukasz Dziedzic ([email protected]) with Reserved Font Name "Lato"
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+https://openfontlicense.org
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded, 
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.