From 7c246c60caff1a6fa85b0ed64516a5d81428d8c9 Mon Sep 17 00:00:00 2001 From: Arisu Tachibana Date: Wed, 20 Nov 2024 19:25:16 +0900 Subject: [PATCH 1/2] workflows/docs: Add main menu Signed-off-by: Arisu Tachibana --- docs/_index.md | 6 +----- docs/checkout.md | 5 ----- docs/results.md | 5 ----- docs/testretry.md | 5 ----- hugo.toml | 39 +++++++++++++++++++++++++++++++++++---- 5 files changed, 36 insertions(+), 24 deletions(-) diff --git a/docs/_index.md b/docs/_index.md index 927bee3..5ba7254 100644 --- a/docs/_index.md +++ b/docs/_index.md @@ -3,11 +3,6 @@ title = 'kci-dev' date = 2024-01-14T07:07:07+01:00 +++ -
-
-
-
- # kci-dev kci-dev is a cmdline tool for interact with a enabled KernelCI server @@ -97,3 +92,4 @@ kci-dev --settings /path/to/.kci-dev.toml ### results - [results](results) + diff --git a/docs/checkout.md b/docs/checkout.md index 5ab78b6..d10ea6f 100644 --- a/docs/checkout.md +++ b/docs/checkout.md @@ -3,11 +3,6 @@ title = 'checkout' date = 2024-01-14T07:07:07+01:00 +++ -
-
-
-
- ## checkout This command allow to test arbitary commit on the KernelCI Pipeline instance. This might be useful in several cases: diff --git a/docs/results.md b/docs/results.md index a8c2c69..d1a6747 100644 --- a/docs/results.md +++ b/docs/results.md @@ -3,11 +3,6 @@ title = 'results' date = 2024-01-14T07:07:07+01:00 +++ -
-
-
-
- ### results This command will show the test result by node id. diff --git a/docs/testretry.md b/docs/testretry.md index d0ebf1d..0d4009f 100644 --- a/docs/testretry.md +++ b/docs/testretry.md @@ -3,11 +3,6 @@ title = 'testretry' date = 2024-01-14T07:07:07+01:00 +++ -
-
-
-
- ### testretry This command will retry the failed tests. In some cases tests may fail due to network issues, hardware problems, diff --git a/hugo.toml b/hugo.toml index 96cc507..b1ba708 100644 --- a/hugo.toml +++ b/hugo.toml @@ -4,15 +4,46 @@ title = 'kci-dev' description = 'kci-dev is a cmdline tool for interact with a enabled KernelCI server.' contentDir = "docs/" +pygmentsCodeFences = true +pygmentsUseClasses = false +pygmentsUseClassic = false +pygmentsStyle = "tango" + [markup] [markup.goldmark] [markup.goldmark.renderer] unsafe = true + [markup.highlight] + style = "tango" [params.ui] -sidebar_menu_compact = false -breadcrumb_disable = false -sidebar_search_disable = false -navbar_logo = true +sidebar_menu_compact = true +breadcrumb_disable = true +sidebar_search_disable = true +navbar_logo = false footer_about_enable = true navbar_translucent_over_cover_disable = true + +[params.navbar.stickyNavBar] +enable = false +showOnScrollUp = false + +[menu] + [[menu.main]] + name = "Home" + pageRef = "/" + weight = 10 + + [[menu.main]] + name = "checkout" + pageRef = "checkout/" + weight = 20 + [[menu.main]] + name = "testretry" + pageRef = "testretry/" + weight = 20 + + [[menu.main]] + name = "results" + url = "results/" + weight = 20 From e27529dc9602739ed3726cde33d507faa1fe8ef1 Mon Sep 17 00:00:00 2001 From: Arisu Tachibana Date: Thu, 21 Nov 2024 08:17:51 +0900 Subject: [PATCH 2/2] hugo: Fix the navbar Signed-off-by: Arisu Tachibana --- .github/workflows/docs.yml | 1 + hugo.toml | 11 ++++------- 2 files changed, 5 insertions(+), 7 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 72fee3f..2695d52 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -51,6 +51,7 @@ jobs: TZ: America/Los_Angeles run: | git clone --depth 1 --branch v0.11.0 https://github.com/google/docsy.git themes/docsy + sed -i 's/fixed/relative/g' themes/docsy/assets/scss/_nav.scss git clone --depth 1 --branch 6.7.0 https://github.com/FortAwesome/Font-Awesome.git themes/github.com/FortAwesome/Font-Awesome git clone --depth 1 --branch v5.3.3 https://github.com/twbs/bootstrap.git themes/github.com/twbs/bootstrap hugo \ diff --git a/hugo.toml b/hugo.toml index b1ba708..133c859 100644 --- a/hugo.toml +++ b/hugo.toml @@ -17,16 +17,13 @@ pygmentsStyle = "tango" style = "tango" [params.ui] -sidebar_menu_compact = true -breadcrumb_disable = true sidebar_search_disable = true navbar_logo = false footer_about_enable = true -navbar_translucent_over_cover_disable = true +ul_show = 1 +sidebar_menu_foldable = true +sidebar_cache_limit = 1000 -[params.navbar.stickyNavBar] -enable = false -showOnScrollUp = false [menu] [[menu.main]] @@ -43,7 +40,7 @@ showOnScrollUp = false pageRef = "testretry/" weight = 20 - [[menu.main]] + [[menu.main]] name = "results" url = "results/" weight = 20