From a87d0fcf92b7b5c8126df7365c845055b6cdb55a Mon Sep 17 00:00:00 2001 From: Johannes Kirschbauer Date: Fri, 20 Dec 2024 19:13:55 +0100 Subject: [PATCH] Docs: add permanent footer with prev/next buttons --- docs/mkdocs.yml | 8 +++++--- docs/site/clanmodules/index.md | 8 +++++--- docs/site/manual/disk-templates.md | 4 +++- 3 files changed, 13 insertions(+), 7 deletions(-) diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 103870220..7f58ecd40 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -1,7 +1,7 @@ site_name: Clan Documentation site_url: https://docs.clan.lol repo_url: https://git.clan.lol/clan/clan-core/ -repo_name: clan-core +repo_name: "_>" edit_uri: _edit/main/docs/docs/ validation: @@ -148,11 +148,13 @@ theme: features: - navigation.instant - navigation.tabs + - navigation.tabs.sticky + - navigation.footer - content.code.annotate - content.code.copy - content.tabs.link icon: - repo: fontawesome/brands/git-alt + repo: fontawesome/brands/git custom_dir: overrides palette: @@ -181,7 +183,7 @@ extra: social: - icon: fontawesome/regular/comment link: https://matrix.to/#/#clan:clan.lol - - icon: fontawesome/brands/gitlab + - icon: fontawesome/brands/git link: https://git.clan.lol/clan/clan-core - icon: fontawesome/brands/github link: https://github.com/clan-lol/clan-core diff --git a/docs/site/clanmodules/index.md b/docs/site/clanmodules/index.md index ead4607e1..9f818f65a 100644 --- a/docs/site/clanmodules/index.md +++ b/docs/site/clanmodules/index.md @@ -1,10 +1,12 @@ # Authoring a clanModule +!!! Danger ":fontawesome-solid-road-barrier: Under Construction :fontawesome-solid-road-barrier:" + Currently under construction use with caution + + :fontawesome-solid-road-barrier: :fontawesome-solid-road-barrier: :fontawesome-solid-road-barrier: + This site will guide you through authoring your first module. Explaining which conventions must be followed, such that others will have an enjoyable experience and the module can be used with minimal effort. -:fontawesome-solid-road-barrier: :fontawesome-solid-road-barrier: :fontawesome-solid-road-barrier: -Under construction -:fontawesome-solid-road-barrier: :fontawesome-solid-road-barrier: :fontawesome-solid-road-barrier: !!! Tip External ClanModules can be ad-hoc loaded via [`clan.inventory.modules`](../reference/nix-api/inventory.md#modules) diff --git a/docs/site/manual/disk-templates.md b/docs/site/manual/disk-templates.md index 1ce8e8597..b8dc3598d 100644 --- a/docs/site/manual/disk-templates.md +++ b/docs/site/manual/disk-templates.md @@ -1,9 +1,11 @@ # Disk Templates -!!! Danger "!!! Under construction !!!" +!!! Danger ":fontawesome-solid-road-barrier: Under Construction :fontawesome-solid-road-barrier:" Currently under construction use with caution + :fontawesome-solid-road-barrier: :fontawesome-solid-road-barrier: :fontawesome-solid-road-barrier: + ## Structure