- Render breadcrumb navigation for all pages - Use common page layout for hard-coded HTML pages - Sort hard-coded HTML into sitemap - Show link to source in the footer Signed-off-by: Valentin Gagarin <valentin@gagarin.work> --- Documentation/_includes/breadcrumb.html | 23 +++++++++++ Documentation/_includes/footer_custom.html | 10 ++--- Documentation/_includes/sitemap.html | 2 +- Documentation/_layouts/page.html | 13 +++---- Documentation/bibliography.html | 38 +++--------------- Documentation/contributing.html | 38 +++--------------- Documentation/design.html | 38 +++--------------- Documentation/doc/index.adoc | 3 +- Documentation/impressum.html | 35 +++-------------- Documentation/index.html | 33 +++------------- Documentation/logo/index.html | 38 +++--------------- Documentation/motivation.html | 38 +++--------------- .../software/cloud-hypervisor/index.html | 39 ++----------------- Documentation/software/index.html | 38 +++--------------- 14 files changed, 80 insertions(+), 306 deletions(-) create mode 100644 Documentation/_includes/breadcrumb.html diff --git a/Documentation/_includes/breadcrumb.html b/Documentation/_includes/breadcrumb.html new file mode 100644 index 0000000..f759807 --- /dev/null +++ b/Documentation/_includes/breadcrumb.html @@ -0,0 +1,23 @@ +{% comment %} +SPDX-License-Identifier: GPL-3.0-or-later +SPDX-FileCopyrightText: 2026 Valentin Gagarin <valentin@gagarin.work> +{% endcomment %} +{%- unless page.url == '/' -%} +<nav aria-label="Breadcrumb"> + <ol> + <li><a href="/">Spectrum</a></li> + {%- assign parts = page.url | split: '/' -%} + {%- assign acc = '' -%} + {%- for part in parts offset: 1 -%} + {%- assign acc = acc | append: '/' | append: part -%} + {%- assign parent_url = acc | append: '/' -%} + {%- if parent_url == page.url -%}{%- continue -%}{%- endif -%} + {%- assign parent = site.pages | where: 'url', parent_url | first -%} + {%- if parent %} + <li><a href="{{ parent.url }}">{{ parent.title }}</a></li> + {%- endif -%} + {%- endfor %} + <li aria-current="page">{{ page.title }}</li> + </ol> +</nav> +{%- endunless -%} diff --git a/Documentation/_includes/footer_custom.html b/Documentation/_includes/footer_custom.html index 2477920..c7ba518 100644 --- a/Documentation/_includes/footer_custom.html +++ b/Documentation/_includes/footer_custom.html @@ -2,9 +2,6 @@ SPDX-FileCopyrightText: 2020 Alyssa Ross <hi@alyssa.is> SPDX-License-Identifier: CC-BY-SA-4.0 OR GFDL-1.3-no-invariants-or-later {% endcomment %} -<p> -<a href="https://spectrum-os.org/git/spectrum/tree/Documentation/{{ page.path }}">Source code for this page</a> - <p> <small>Permission is granted to copy, distribute and/or modify this document under either the terms of the @@ -15,6 +12,7 @@ Documentation License, Version 1.3</a> or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.</small> -<p> -<a href="/sitemap.html"><small>Sitemap</small></a> -<a href="/impressum.html" lang="de"><small>Impressum</small></a> +<p><small> +<a href="/sitemap.html">Sitemap</a> +<a href="https://spectrum-os.org/git/spectrum/tree/Documentation/{{ page.path }}">Source code for this page</a> +<a href="/impressum.html" lang="de">Impressum</a> diff --git a/Documentation/_includes/sitemap.html b/Documentation/_includes/sitemap.html index cd493f8..e1a573c 100644 --- a/Documentation/_includes/sitemap.html +++ b/Documentation/_includes/sitemap.html @@ -33,7 +33,7 @@ which we assume if it is constructed by a directory and contains an index file. {%- assign without_slashes = suffix | replace: "/", "" -%} {%- assign slashes = suffix.size | minus: without_slashes.size -%} {%- assign is_index = false -%} - {%- if p.name == "index.adoc" -%}{%- assign is_index = true -%}{%- endif -%} + {%- if p.name == "index.adoc" or p.name == "index.html" -%}{%- assign is_index = true -%}{%- endif -%} {%- assign is_page = false -%} {%- if is_index == false and slashes == 0 -%}{%- assign is_page = true -%}{%- endif -%} {%- assign is_section = false -%} diff --git a/Documentation/_layouts/page.html b/Documentation/_layouts/page.html index 230b601..f2cf0f6 100644 --- a/Documentation/_layouts/page.html +++ b/Documentation/_layouts/page.html @@ -3,7 +3,7 @@ SPDX-License-Identifier: GPL-3.0-or-later SPDX-FileCopyrightText: 2026 Valentin Gagarin <valentin@gagarin.work> {% endcomment %} <!doctype html> -<html lang="en"> +<html lang="{{ page.lang | default: "en" }}"> <head> @@ -17,13 +17,10 @@ SPDX-FileCopyrightText: 2026 Valentin Gagarin <valentin@gagarin.work> <body> -<nav aria-label="Breadcrumb"> - <ol> - <li><a href="/">Spectrum</a></li> - <li><a href="/doc/">Documentation</a></li> - <li aria-current="page">{{ page.title }}</li> - </ol> -</nav> +{% include breadcrumb.html %} + +{% assign ext = page.path | split: "." | last %} +{% if ext == "html" and page.no_heading != true %}<h1>{{ page.title }}</h1>{% endif %} {{ content }} diff --git a/Documentation/bibliography.html b/Documentation/bibliography.html index f9a8efd..175115a 100644 --- a/Documentation/bibliography.html +++ b/Documentation/bibliography.html @@ -1,26 +1,11 @@ -<!doctype html> +--- +layout: page +title: Bibliography +nav_order: 200 +--- <!-- SPDX-FileCopyrightText: 2019-2023 Alyssa Ross <hi@alyssa.is> --> <!-- SPDX-License-Identifier: CC-BY-SA-4.0 OR GFDL-1.3-no-invariants-or-later --> <!-- SPDX-License-Identifier: GPL-3.0-or-later --> -<html lang="en"> - -<head> - -<meta charset="utf-8"> -<meta name="viewport" content="width=device-width,initial-scale=1"> - -<link rel="icon" href="logo/logo_html.svg"> -<link rel="stylesheet" href="style.css"> - -<title>Spectrum Bibliography</title> - -<body> - -<nav> - <a href=".">Spectrum</a> -</nav> - -<h1>Bibliography</h1> <p>If you'd like to find out when new links are posted, subscribe to the <a href="https://spectrum-os.org/git/www/atom/bibliography.html">cgit @@ -137,16 +122,3 @@ atom feed for this page</a>. <li><cite><a href="https://github.com/cloud-hypervisor/cloud-hypervisor">cloud-hypervisor</a></cite> </ul> - -<p> -<small>Permission is granted to copy, distribute and/or modify this -document under either the terms of the -<a href="https://creativecommons.org/licenses/by-sa/4.0/">Creative -Commons Attribution-ShareAlike 4.0 International License</a>, or the -<a href="https://www.gnu.org/licenses/fdl-1.3.html">GNU Free -Documentation License, Version 1.3</a> or any later version published -by the Free Software Foundation; with no Invariant Sections, no -Front-Cover Texts, and no Back-Cover Texts.</small> - -<p> -<a href="impressum.html" lang="de"><small>Impressum</small></a> diff --git a/Documentation/contributing.html b/Documentation/contributing.html index ea85499..8f9948b 100644 --- a/Documentation/contributing.html +++ b/Documentation/contributing.html @@ -1,26 +1,11 @@ -<!doctype html> +--- +layout: page +title: Contributing to Spectrum +nav_order: 3 +--- <!-- SPDX-FileCopyrightText: 2019-2020, 2022 Alyssa Ross <hi@alyssa.is> --> <!-- SPDX-License-Identifier: CC-BY-SA-4.0 OR GFDL-1.3-no-invariants-or-later --> <!-- SPDX-License-Identifier: GPL-3.0-or-later --> -<html lang="en"> - -<head> - -<meta charset="utf-8"> -<meta name="viewport" content="width=device-width,initial-scale=1"> - -<link rel="icon" href="logo/logo_html.svg"> -<link rel="stylesheet" href="style.css"> - -<title>Contributing to Spectrum</title> - -<body> - -<nav> - <a href=".">Spectrum</a> -</nav> - -<h1>Contributing to Spectrum</h1> <p> Thank you so much for your interest in contributing to Spectrum. @@ -104,16 +89,3 @@ on <a href="/doc/contributing/communication.html#spectrum-discuss">spectrum-disc or in real time on <a href="/doc/contributing/communication.html#chat">Matrix or IRC</a>. - -<p> -<small>Permission is granted to copy, distribute and/or modify this -document under either the terms of the -<a href="https://creativecommons.org/licenses/by-sa/4.0/">Creative -Commons Attribution-ShareAlike 4.0 International License</a>, or the -<a href="https://www.gnu.org/licenses/fdl-1.3.html">GNU Free -Documentation License, Version 1.3</a> or any later version published -by the Free Software Foundation; with no Invariant Sections, no -Front-Cover Texts, and no Back-Cover Texts.</small> - -<p> -<a href="impressum.html" lang="de"><small>Impressum</small></a> diff --git a/Documentation/design.html b/Documentation/design.html index 51e0b77..0aa8762 100644 --- a/Documentation/design.html +++ b/Documentation/design.html @@ -1,26 +1,11 @@ -<!doctype html> +--- +layout: page +title: Design +nav_order: 2 +--- <!-- SPDX-FileCopyrightText: 2019-2020, 2022, 2024 Alyssa Ross <hi@alyssa.is> --> <!-- SPDX-License-Identifier: CC-BY-SA-4.0 OR GFDL-1.3-no-invariants-or-later --> <!-- SPDX-License-Identifier: GPL-3.0-or-later --> -<html lang="en"> - -<head> - -<meta charset="utf-8"> -<meta name="viewport" content="width=device-width,initial-scale=1"> - -<link rel="icon" href="logo/logo_html.svg"> -<link rel="stylesheet" href="style.css"> - -<title>Spectrum Design</title> - -<body> - -<nav> - <a href=".">Spectrum</a> -</nav> - -<h1>Spectrum Design</h1> <p> Spectrum will, for now, be a Linux-based system, with packages from @@ -96,16 +81,3 @@ diverse range of hardware, to verify that the images correspond to the source code, and are free of tampering. Work like <a href="https://nix-community.github.io/trustix/">Trustix</a> will be important to reaching this goal. - -<p> -<small>Permission is granted to copy, distribute and/or modify this -document under either the terms of the -<a href="https://creativecommons.org/licenses/by-sa/4.0/">Creative -Commons Attribution-ShareAlike 4.0 International License</a>, or the -<a href="https://www.gnu.org/licenses/fdl-1.3.html">GNU Free -Documentation License, Version 1.3</a> or any later version published -by the Free Software Foundation; with no Invariant Sections, no -Front-Cover Texts, and no Back-Cover Texts.</small> - -<p> -<a href="impressum.html" lang="de"><small>Impressum</small></a> diff --git a/Documentation/doc/index.adoc b/Documentation/doc/index.adoc index a24d85f..81b2a18 100644 --- a/Documentation/doc/index.adoc +++ b/Documentation/doc/index.adoc @@ -1,5 +1,6 @@ -= Spectrum Documentation += Documentation :page-liquid: +:page-nav_order: 100 // SPDX-FileCopyrightText: 2022 Alyssa Ross <hi@alyssa.is> // SPDX-FileCopyrightText: 2022 Unikie diff --git a/Documentation/impressum.html b/Documentation/impressum.html index b4806fe..416ce67 100644 --- a/Documentation/impressum.html +++ b/Documentation/impressum.html @@ -1,26 +1,11 @@ -<!doctype html> +--- +layout: page +title: Impressum +lang: de +--- <!-- SPDX-FileCopyrightText: 2019-2020, 2022 Alyssa Ross <hi@alyssa.is> --> <!-- SPDX-License-Identifier: CC-BY-SA-4.0 OR GFDL-1.3-no-invariants-or-later --> <!-- SPDX-License-Identifier: GPL-3.0-or-later --> -<html lang="de"> - -<head> - -<meta charset="utf-8"> -<meta name="viewport" content="width=device-width,initial-scale=1"> - -<link rel="icon" href="logo/logo_html.svg"> -<link rel="stylesheet" href="style.css"> - -<title>Impressum</title> - -<body> - -<nav> - <a href=".">Spectrum</a> -</nav> - -<h1>Impressum</h1> <address> <p> @@ -32,13 +17,3 @@ <p> hi@alyssa.is </address> - -<p lang="en"> -<small>Permission is granted to copy, distribute and/or modify this -document under either the terms of the -<a href="https://creativecommons.org/licenses/by-sa/4.0/">Creative -Commons Attribution-ShareAlike 4.0 International License</a>, or the -<a href="https://www.gnu.org/licenses/fdl-1.3.html">GNU Free -Documentation License, Version 1.3</a> or any later version published -by the Free Software Foundation; with no Invariant Sections, no -Front-Cover Texts, and no Back-Cover Texts.</small> diff --git a/Documentation/index.html b/Documentation/index.html index 51685dd..6d6faf7 100644 --- a/Documentation/index.html +++ b/Documentation/index.html @@ -1,20 +1,12 @@ -<!doctype html> +--- +layout: page +title: Spectrum, a step towards usable secure computing +no_heading: true +nav_order: 0 +--- <!-- SPDX-FileCopyrightText: 2019-2020, 2022, 2024 Alyssa Ross <hi@alyssa.is> --> <!-- SPDX-License-Identifier: CC-BY-SA-4.0 OR GFDL-1.3-no-invariants-or-later --> <!-- SPDX-License-Identifier: GPL-3.0-or-later --> -<html lang="en"> - -<head> - -<meta charset="utf-8"> -<meta name="viewport" content="width=device-width,initial-scale=1"> - -<link rel="icon" href="logo/logo_html.svg"> -<link rel="stylesheet" href="style.css"> - -<title>Spectrum, a step towards usable secure computing</title> - -<body> <a href="logo" style="float: left; margin: 0 1em 0.5em 0"> <img class="logo" src="logo/logo_html.svg" width="70" height="70" alt="Spectrum logo"> @@ -95,16 +87,3 @@ initiative by the Digital Single Market of the European Commission. <li><a href="https://cryptpad.fr/kanban/#/2/kanban/view/yLtGXWLV6U7X5+Z1ay+oXKZMrSacqQe+51nXZYRh3ck/">Upstream bug/patch tracking</a> </ul> </nav> - -<p> -<small>Permission is granted to copy, distribute and/or modify this -document under either the terms of the -<a href="https://creativecommons.org/licenses/by-sa/4.0/">Creative -Commons Attribution-ShareAlike 4.0 International License</a>, or the -<a href="https://www.gnu.org/licenses/fdl-1.3.html">GNU Free -Documentation License, Version 1.3</a> or any later version published -by the Free Software Foundation; with no Invariant Sections, no -Front-Cover Texts, and no Back-Cover Texts.</small> - -<p> -<a href="impressum.html" lang="de"><small>Impressum</small></a> diff --git a/Documentation/logo/index.html b/Documentation/logo/index.html index 2354062..fbab443 100644 --- a/Documentation/logo/index.html +++ b/Documentation/logo/index.html @@ -1,26 +1,11 @@ -<!doctype html> +--- +layout: page +title: Logo +nav_order: 1002 +--- <!-- SPDX-FileCopyrightText: 2019-2020, 2022 Alyssa Ross <hi@alyssa.is> --> <!-- SPDX-License-Identifier: CC-BY-SA-4.0 OR GFDL-1.3-no-invariants-or-later --> <!-- SPDX-License-Identifier: GPL-3.0-or-later --> -<html lang="en"> - -<head> - -<meta charset="utf-8"> -<meta name="viewport" content="width=device-width,initial-scale=1"> - -<link rel="icon" href="logo_html.svg"> -<link rel="stylesheet" href="../style.css"> - -<title>Spectrum logo</title> - -<body> - -<nav> - <a href="..">Spectrum</a> -</nav> - -<h1>Logo</h1> <p> <img class="logo" src="logo_html.svg" width="200" height="200" alt="" style="margin: 0 auto"> @@ -48,16 +33,3 @@ Mesh Gradients</a>. <li><a href="logo_mesh.svg" download>logo_mesh.svg</a> (for Inkscape) </ul> - -<p> -<small>Permission is granted to copy, distribute and/or modify this -document under either the terms of the -<a href="https://creativecommons.org/licenses/by-sa/4.0/">Creative -Commons Attribution-ShareAlike 4.0 International License</a>, or the -<a href="https://www.gnu.org/licenses/fdl-1.3.html">GNU Free -Documentation License, Version 1.3</a> or any later version published -by the Free Software Foundation; with no Invariant Sections, no -Front-Cover Texts, and no Back-Cover Texts.</small> - -<p> -<a href="../impressum.html" lang="de"><small>Impressum</small></a> diff --git a/Documentation/motivation.html b/Documentation/motivation.html index 4cbe5b0..e144251 100644 --- a/Documentation/motivation.html +++ b/Documentation/motivation.html @@ -1,26 +1,11 @@ -<!doctype html> +--- +layout: page +title: Motivation for Spectrum +nav_order: 1 +--- <!-- SPDX-FileCopyrightText: 2019-2020, 2022 Alyssa Ross <hi@alyssa.is> --> <!-- SPDX-License-Identifier: CC-BY-SA-4.0 OR GFDL-1.3-no-invariants-or-later --> <!-- SPDX-License-Identifier: GPL-3.0-or-later --> -<html lang="en"> - -<head> - -<meta charset="utf-8"> -<meta name="viewport" content="width=device-width,initial-scale=1"> - -<link rel="icon" href="logo/logo_html.svg"> -<link rel="stylesheet" href="style.css"> - -<title>Motivation for Spectrum</title> - -<body> - -<nav> - <a href=".">Spectrum</a> -</nav> - -<h1>Motivation for Spectrum</h1> <p> Existing attempts to improve on the security of Unix-like operating @@ -122,16 +107,3 @@ major security issue. <p> The last release of SubgraphOS was an alpha in 2017. - -<p> -<small>Permission is granted to copy, distribute and/or modify this -document under either the terms of the -<a href="https://creativecommons.org/licenses/by-sa/4.0/">Creative -Commons Attribution-ShareAlike 4.0 International License</a>, or the -<a href="https://www.gnu.org/licenses/fdl-1.3.html">GNU Free -Documentation License, Version 1.3</a> or any later version published -by the Free Software Foundation; with no Invariant Sections, no -Front-Cover Texts, and no Back-Cover Texts.</small> - -<p> -<a href="impressum.html" lang="de"><small>Impressum</small></a> diff --git a/Documentation/software/cloud-hypervisor/index.html b/Documentation/software/cloud-hypervisor/index.html index 1845068..9b4315c 100644 --- a/Documentation/software/cloud-hypervisor/index.html +++ b/Documentation/software/cloud-hypervisor/index.html @@ -1,26 +1,10 @@ -<!doctype html> +--- +layout: page +title: Cloud Hypervisor with virtio-gpu support +--- <!-- SPDX-FileCopyrightText: 2019-2020, 2022, 2024 Alyssa Ross <hi@alyssa.is> --> <!-- SPDX-License-Identifier: CC-BY-SA-4.0 OR GFDL-1.3-no-invariants-or-later --> <!-- SPDX-License-Identifier: GPL-3.0-or-later --> -<html lang="en"> - -<head> - -<meta charset="utf-8"> -<meta name="viewport" content="width=device-width,initial-scale=1"> - -<link rel="icon" href="../../logo/logo_html.svg"> -<link rel="stylesheet" href="../../style.css"> - -<title>Cloud Hypervisor with virtio-gpu support</title> - -<body> - -<nav> - <a href="../..">Spectrum</a> -</nav> - -<h1>Cloud Hypervisor with virtio-gpu support</h1> <p> This is a patchset for <a href="https://cloudhypervisor.org/">Cloud @@ -162,18 +146,3 @@ the <a href="mailto:discuss@spectrum-os.org">discuss@spectrum-os.org</a> list</a>, or ask in the Spectrum <a href="/doc/contributing/communication.html#chat">Matrix chat</a>. - -<hr> - -<p> -<small>Permission is granted to copy, distribute and/or modify this -document under either the terms of the -<a href="https://creativecommons.org/licenses/by-sa/4.0/">Creative -Commons Attribution-ShareAlike 4.0 International License</a>, or the -<a href="https://www.gnu.org/licenses/fdl-1.3.html">GNU Free -Documentation License, Version 1.3</a> or any later version published -by the Free Software Foundation; with no Invariant Sections, no -Front-Cover Texts, and no Back-Cover Texts.</small> - -<p> -<a href="../../impressum.html" lang="de"><small>Impressum</small></a> diff --git a/Documentation/software/index.html b/Documentation/software/index.html index 2a8a852..0265ca1 100644 --- a/Documentation/software/index.html +++ b/Documentation/software/index.html @@ -1,41 +1,13 @@ -<!doctype html> +--- +layout: page +title: Spectrum software +nav_order: 10 +--- <!-- SPDX-FileCopyrightText: 2019-2020, 2022, 2024 Alyssa Ross <hi@alyssa.is> --> <!-- SPDX-License-Identifier: CC-BY-SA-4.0 OR GFDL-1.3-no-invariants-or-later --> <!-- SPDX-License-Identifier: GPL-3.0-or-later --> -<html lang="en"> - -<head> - -<meta charset="utf-8"> -<meta name="viewport" content="width=device-width,initial-scale=1"> - -<link rel="icon" href="../logo/logo_html.svg"> -<link rel="stylesheet" href="../style.css"> - -<title>Spectrum software</title> - -<body> - -<nav> - <a href="..">Spectrum</a> -</nav> - -<h1>Spectrum software</h1> <ul> <li><a href="cloud-hypervisor">Cloud Hypervisor with virtio-gpu support</a> </ul> - -<p> -<small>Permission is granted to copy, distribute and/or modify this -document under either the terms of the -<a href="https://creativecommons.org/licenses/by-sa/4.0/">Creative -Commons Attribution-ShareAlike 4.0 International License</a>, or the -<a href="https://www.gnu.org/licenses/fdl-1.3.html">GNU Free -Documentation License, Version 1.3</a> or any later version published -by the Free Software Foundation; with no Invariant Sections, no -Front-Cover Texts, and no Back-Cover Texts.</small> - -<p> -<a href="../impressum.html" lang="de"><small>Impressum</small></a> -- 2.51.2