From 0e42c0b6f83308f8771208fb7db7f63ad0f0d81c Mon Sep 17 00:00:00 2001 From: predictiple Date: Mon, 21 Sep 2026 09:43:49 +0200 Subject: [PATCH 1/6] More theme tweaks (#1309) --- content/announcements/2021-artifact-contest/index.md | 2 ++ content/announcements/2022-velocon/index.md | 2 ++ content/announcements/2023-trainings/index.md | 2 ++ content/announcements/_index.md | 2 +- content/announcements/advisories/_index.md | 3 ++- content/artifact_references/_index.md | 1 - content/blog/_index.md | 2 +- content/dev/_index.md | 1 + content/dev/dev-server/index.md | 2 ++ content/dev/image-guidelines/index.md | 2 ++ content/dev/prose-guidelines/index.md | 2 ++ content/dev/test/index.md | 2 ++ content/dev/vale_linting/index.md | 1 + content/docs/_index.md | 1 - content/docs/artifacts/_index.md | 1 + content/docs/artifacts/artifact_reference/index.md | 1 - content/docs/artifacts/exchange_reference/index.md | 1 - content/docs/cli/_index.md | 1 + content/docs/clients/_index.md | 1 + content/docs/deployment/_index.md | 1 + content/docs/deployment/clients/index.md | 1 + content/docs/deployment/logging/index.md | 1 + content/docs/deployment/orgs/index.md | 1 + content/docs/deployment/references/index.md | 1 + content/docs/deployment/resources/index.md | 1 + content/docs/deployment/security/index.md | 1 + .../docs/deployment/server/multifrontend/index.md | 1 + content/docs/file_collection/_index.md | 1 + content/docs/forensic/_index.md | 1 + content/docs/forensic/binary/index.md | 1 + content/docs/gui/_index.md | 2 ++ content/docs/hunting/_index.md | 1 + content/docs/notebooks/_index.md | 1 + content/docs/overview/_index.md | 1 + content/docs/overview/support/index.md | 1 + content/docs/server_automation/_index.md | 1 + content/docs/sigma/index.md | 1 + content/docs/troubleshooting/_index.md | 1 + .../docs/troubleshooting/debugging/client/_index.md | 1 + .../debugging/client/client_flows/index.md | 1 + .../debugging/client/client_monitoring/index.md | 1 + .../docs/troubleshooting/debugging/global/_index.md | 1 + .../debugging/global/datastore/_index.md | 1 + .../debugging/global/datastore/replication/index.md | 1 + .../debugging/global/services/_index.md | 1 + .../debugging/global/services/export/index.md | 1 + .../debugging/global/services/open_close/index.md | 1 + .../debugging/global/services/tempfiles/index.md | 1 + .../debugging/global/services/throttler/index.md | 1 + .../debugging/global/services/user_manager/index.md | 1 + .../debugging/global/services/worker/index.md | 1 + .../troubleshooting/debugging/global/vql/_index.md | 1 + .../debugging/global/vql/plugins/_index.md | 1 + .../debugging/global/vql/plugins/etw/index.md | 1 + .../debugging/global/vql/plugins/glob/index.md | 1 + .../debugging/global/vql/plugins/ntfs/index.md | 1 + .../debugging/global/vql/plugins/process/index.md | 1 + .../debugging/global/vql/plugins/sigma/index.md | 1 + .../debugging/global/vql/plugins/sqlite/index.md | 1 + .../global/vql/plugins/windows_event/index.md | 1 + .../debugging/global/vql/plugins/zip/index.md | 1 + .../debugging/global/vql/queries/_index.md | 1 + .../global/vql/queries/active_queries/index.md | 1 + .../global/vql/queries/plugin_monitor/index.md | 1 + .../global/vql/queries/recent_queries/index.md | 1 + .../troubleshooting/debugging/internal/_index.md | 1 + .../debugging/internal/go_profiles/index.md | 1 + .../debugging/internal/metrics/index.md | 1 + content/docs/troubleshooting/debugging/org/_index.md | 1 + .../troubleshooting/debugging/org/services/_index.md | 1 + .../org/services/broadcast_service/index.md | 1 + .../debugging/org/services/notifier/index.md | 1 + .../debugging/org/services/queue_manager/index.md | 1 + .../debugging/org/services/vfs_service/index.md | 1 + content/docs/vql/_index.md | 1 + content/docs/vql/vql_reference/index.md | 1 - content/downloads/_index.md | 1 - content/downloads/previous_downloads/index.md | 2 +- content/downloads/rc_downloads/index.md | 2 +- content/exchange/_index.md | 1 - content/knowledge_base/_index.md | 2 +- content/presentations/_index.md | 1 - content/rss/index.md | 1 + content/search/index.md | 1 - content/training/_index.md | 1 - content/training/comparisons/_index.md | 3 ++- content/training/comparisons/eztools/index.md | 2 ++ content/training/comparisons/raw_copy/index.md | 2 ++ content/training/playbooks/_index.md | 3 +-- content/training/playbooks/finding_files/index.md | 1 + content/training/playbooks/preservation/index.md | 1 + content/training/playbooks/triage-logs/index.md | 1 + content/vql_reference/_index.md | 1 - layouts/shortcodes/children.html | 9 ++++++++- layouts/wide/single.html | 12 ++++++++++++ 95 files changed, 114 insertions(+), 21 deletions(-) create mode 100644 layouts/wide/single.html diff --git a/content/announcements/2021-artifact-contest/index.md b/content/announcements/2021-artifact-contest/index.md index 65e0083716eb..7dd25a5d6516 100644 --- a/content/announcements/2021-artifact-contest/index.md +++ b/content/announcements/2021-artifact-contest/index.md @@ -1,6 +1,8 @@ --- +icon: gift menutitle: "2021 Contest" title: "2021 Velociraptor Contributor Competition" +date: 2021-07-23 description: | Were you planning to try Velociraptor in the past? You can now win some awesome prizes by learning and applying Velociraptor to your own network. diff --git a/content/announcements/2022-velocon/index.md b/content/announcements/2022-velocon/index.md index d5ba71d33f58..4e78081d9821 100644 --- a/content/announcements/2022-velocon/index.md +++ b/content/announcements/2022-velocon/index.md @@ -1,6 +1,8 @@ --- +icon: video-camera menutitle: "2022 VeloCon" title: "The 2022 Velociraptor Conference - Digging together..." +date: 2022-04-28 description: | Join us in our annual Velociraptor conference to discuss and share your experiences with Velociraptor! diff --git a/content/announcements/2023-trainings/index.md b/content/announcements/2023-trainings/index.md index 900473a00ed9..fdbce95e69a8 100644 --- a/content/announcements/2023-trainings/index.md +++ b/content/announcements/2023-trainings/index.md @@ -1,6 +1,8 @@ --- +icon: academic-cap menutitle: "Trainings" title: "Upcoming Training Events" +date: 2023-03-31 description: | The Velociraptor team will be at BlackHat this year! diff --git a/content/announcements/_index.md b/content/announcements/_index.md index b53cd46365e6..32c2d51ae3a7 100644 --- a/content/announcements/_index.md +++ b/content/announcements/_index.md @@ -6,9 +6,9 @@ sidebar: exclude: true menutitle: "Announcements" title: "Announcements" +date: 2021-07-23 weight: 5 no_edit: true -pre: description: | Release announcements, security advisories and community news for Velociraptor. diff --git a/content/announcements/advisories/_index.md b/content/announcements/advisories/_index.md index fe76ce23beed..597f5ae070ee 100644 --- a/content/announcements/advisories/_index.md +++ b/content/announcements/advisories/_index.md @@ -1,7 +1,9 @@ --- +icon: shield-exclamation type: docs-no-toc menutitle: "Security Advisories" title: "Security Advisories" +date: 2024-11-22 summary: | CVEs and other security advisories. description: | @@ -9,7 +11,6 @@ description: | weight: 10 no_edit: true noTitle: true -pre: outputs: - html - RSS diff --git a/content/artifact_references/_index.md b/content/artifact_references/_index.md index a0b05217d950..863dfc82a176 100644 --- a/content/artifact_references/_index.md +++ b/content/artifact_references/_index.md @@ -7,7 +7,6 @@ title: "Artifact Reference" date: 2021-06-12T14:03:59Z draft: false weight: 160 -pre: no_edit: true disableToc: false noTitle: true diff --git a/content/blog/_index.md b/content/blog/_index.md index e7a638815d12..6058d3ed8921 100644 --- a/content/blog/_index.md +++ b/content/blog/_index.md @@ -6,11 +6,11 @@ sidebar: exclude: true menutitle: "Blog" title: "Velociraptor Blog" +date: 2021-06-10 weight: 120 no_edit: true disableToc: false no_children: true -pre: rss_data_file: static/blog/data.json rss_title: Velociraptor Blog noTitle: true diff --git a/content/dev/_index.md b/content/dev/_index.md index 956ce79ce255..580df6836a99 100644 --- a/content/dev/_index.md +++ b/content/dev/_index.md @@ -5,6 +5,7 @@ cascade: sidebar: exclude: true title: Documentation Development Guidelines +date: 2026-03-28 no_menu: true description: | If you are new to contributing content to the Velociraptor project diff --git a/content/dev/dev-server/index.md b/content/dev/dev-server/index.md index e233d86617ab..39a718d7319a 100644 --- a/content/dev/dev-server/index.md +++ b/content/dev/dev-server/index.md @@ -1,5 +1,7 @@ --- +icon: server title: Setting up a Hugo development server +date: 2026-05-25 weight: 20 last_reviewed: 2026-04-29 summary: | diff --git a/content/dev/image-guidelines/index.md b/content/dev/image-guidelines/index.md index 84f1b19352c7..2f8b7dd264f8 100644 --- a/content/dev/image-guidelines/index.md +++ b/content/dev/image-guidelines/index.md @@ -1,5 +1,7 @@ --- +icon: photograph title: Guidelines for creating image content +date: 2024-11-25 last_reviewed: 2026-04-29 weight: 40 summary: | diff --git a/content/dev/prose-guidelines/index.md b/content/dev/prose-guidelines/index.md index c813813a58e6..bb238cc42061 100644 --- a/content/dev/prose-guidelines/index.md +++ b/content/dev/prose-guidelines/index.md @@ -1,5 +1,7 @@ --- +icon: pencil title: Guidelines for prose (written content) +date: 2024-12-01 weight: 30 last_reviewed: 2026-04-29 summary: diff --git a/content/dev/test/index.md b/content/dev/test/index.md index a1cc59c5e360..084c53c8f8d4 100644 --- a/content/dev/test/index.md +++ b/content/dev/test/index.md @@ -1,5 +1,7 @@ --- +icon: beaker title: Test Content +date: 2026-03-28 weight: 50 last_reviewed: 2026-04-29 summary: A page for testing and previewing the presentation of common content components diff --git a/content/dev/vale_linting/index.md b/content/dev/vale_linting/index.md index 0ebec9bb8628..d713023259bf 100644 --- a/content/dev/vale_linting/index.md +++ b/content/dev/vale_linting/index.md @@ -1,4 +1,5 @@ --- +icon: check-circle title: "Linting with Vale" menutitle: "Linting" date: 2026-05-01 diff --git a/content/docs/_index.md b/content/docs/_index.md index 1bd17f1b0716..1d2ce3d5b768 100644 --- a/content/docs/_index.md +++ b/content/docs/_index.md @@ -6,7 +6,6 @@ title: "Documentation" date: 2021-06-23T08:29:57Z draft: false weight: 20 -pre: description: | Welcome to Velociraptor's Documentation site. --- diff --git a/content/docs/artifacts/_index.md b/content/docs/artifacts/_index.md index 5722295e8dcf..2241208091a0 100644 --- a/content/docs/artifacts/_index.md +++ b/content/docs/artifacts/_index.md @@ -1,4 +1,5 @@ --- +icon: document-search menutitle: "Artifacts" title: "Velociraptor Artifacts" date: 2021-06-12 diff --git a/content/docs/artifacts/artifact_reference/index.md b/content/docs/artifacts/artifact_reference/index.md index e974cc320558..66e945c22992 100644 --- a/content/docs/artifacts/artifact_reference/index.md +++ b/content/docs/artifacts/artifact_reference/index.md @@ -8,7 +8,6 @@ noDisqus: true no_edit: true disableToc: true chapter: false -pre: summary: "Search our library of built-in artifacts" --- diff --git a/content/docs/artifacts/exchange_reference/index.md b/content/docs/artifacts/exchange_reference/index.md index 69a1fd238465..c353c1ff2b4a 100644 --- a/content/docs/artifacts/exchange_reference/index.md +++ b/content/docs/artifacts/exchange_reference/index.md @@ -10,7 +10,6 @@ noDisqus: true no_edit: true disableToc: false chapter: false -pre: summary: "Search our library of community-contributed artifacts" --- diff --git a/content/docs/cli/_index.md b/content/docs/cli/_index.md index cc4b63c8c887..02420edb7a81 100644 --- a/content/docs/cli/_index.md +++ b/content/docs/cli/_index.md @@ -1,4 +1,5 @@ --- +icon: terminal menutitle: "CLI" title: "The Velociraptor CLI" date: 2025-05-14 diff --git a/content/docs/clients/_index.md b/content/docs/clients/_index.md index 0617c9159a24..9558d531436a 100644 --- a/content/docs/clients/_index.md +++ b/content/docs/clients/_index.md @@ -1,4 +1,5 @@ --- +icon: desktop-computer title: "Managing Clients" date: 2024-12-19 draft: false diff --git a/content/docs/deployment/_index.md b/content/docs/deployment/_index.md index e37de02a7c36..fdfe5336aaf9 100644 --- a/content/docs/deployment/_index.md +++ b/content/docs/deployment/_index.md @@ -1,4 +1,5 @@ --- +icon: server menutitle: "Deployment" title: "Deployment Overview" date: 2021-06-09T03:52:24Z diff --git a/content/docs/deployment/clients/index.md b/content/docs/deployment/clients/index.md index 982ca771550d..28f1323b13e9 100644 --- a/content/docs/deployment/clients/index.md +++ b/content/docs/deployment/clients/index.md @@ -1,5 +1,6 @@ --- title: Deploying Clients +date: 2021-06-09 weight: 25 last_reviewed: 2024-11-30 summary: | diff --git a/content/docs/deployment/logging/index.md b/content/docs/deployment/logging/index.md index 5125140bb7c8..a59e1d075e75 100644 --- a/content/docs/deployment/logging/index.md +++ b/content/docs/deployment/logging/index.md @@ -1,5 +1,6 @@ --- title: Server Logging +date: 2026-09-01 menutitle: Logging weight: 55 last_reviewed: 2026-08-31 diff --git a/content/docs/deployment/orgs/index.md b/content/docs/deployment/orgs/index.md index 1d4d3b8e895a..a7c091e6cd6e 100644 --- a/content/docs/deployment/orgs/index.md +++ b/content/docs/deployment/orgs/index.md @@ -1,6 +1,7 @@ --- menutitle: Organizations title: Organizations and Multi-tenancy +date: 2024-01-24 last_reviewed: 2025-02-24 draft: false weight: 20 diff --git a/content/docs/deployment/references/index.md b/content/docs/deployment/references/index.md index 09de78f7714d..c1de2b44d218 100644 --- a/content/docs/deployment/references/index.md +++ b/content/docs/deployment/references/index.md @@ -1,5 +1,6 @@ --- title: Configuration File Reference +date: 2026-09-20 menutitle: "Config Reference" weight: 120 no_children: true diff --git a/content/docs/deployment/resources/index.md b/content/docs/deployment/resources/index.md index 0443cc7b5cf2..e8f63458ba8d 100644 --- a/content/docs/deployment/resources/index.md +++ b/content/docs/deployment/resources/index.md @@ -1,5 +1,6 @@ --- title: Server Performance and Monitoring +date: 2021-06-10 menutitle: Performance weight: 50 summary: | diff --git a/content/docs/deployment/security/index.md b/content/docs/deployment/security/index.md index db8094a065ee..0fd8bde6ee3c 100644 --- a/content/docs/deployment/security/index.md +++ b/content/docs/deployment/security/index.md @@ -1,6 +1,7 @@ --- menutitle: Security title: Velociraptor Security Configuration +date: 2024-01-17 weight: 46 summary: | Velociraptor is a highly privileged service with elevated access to thousands diff --git a/content/docs/deployment/server/multifrontend/index.md b/content/docs/deployment/server/multifrontend/index.md index 6f4fd504283a..016c380648e3 100644 --- a/content/docs/deployment/server/multifrontend/index.md +++ b/content/docs/deployment/server/multifrontend/index.md @@ -1,6 +1,7 @@ --- menutitle: Multi-Frontend title: Multi-Frontend Configuration +date: 2022-01-02 draft: false weight: 40 summary: | diff --git a/content/docs/file_collection/_index.md b/content/docs/file_collection/_index.md index 3ffb69feee8a..1db590440669 100644 --- a/content/docs/file_collection/_index.md +++ b/content/docs/file_collection/_index.md @@ -1,4 +1,5 @@ --- +icon: folder-open title: "File Acquisition" date: 2021-06-27T04:31:24Z last_reviewed: 2026-01-29 diff --git a/content/docs/forensic/_index.md b/content/docs/forensic/_index.md index 637e2b78c005..6eb570728467 100644 --- a/content/docs/forensic/_index.md +++ b/content/docs/forensic/_index.md @@ -1,4 +1,5 @@ --- +icon: finger-print title: "Forensic Analysis" date: 2021-06-12 draft: false diff --git a/content/docs/forensic/binary/index.md b/content/docs/forensic/binary/index.md index 91f5624812de..4654a49fa1da 100644 --- a/content/docs/forensic/binary/index.md +++ b/content/docs/forensic/binary/index.md @@ -1,5 +1,6 @@ --- title: "Binary parsing" +date: 2022-01-08 summary: | Velociraptor uses VQL to provide the flexibility for users to be able to craft a VQL query in order to retrieve valuable machine state diff --git a/content/docs/gui/_index.md b/content/docs/gui/_index.md index b062ba400044..116eba344419 100644 --- a/content/docs/gui/_index.md +++ b/content/docs/gui/_index.md @@ -1,5 +1,7 @@ --- +icon: view-boards title: "The Admin GUI" +date: 2021-06-10 last_reviewed: 2025-09-29 weight: 15 description: | diff --git a/content/docs/hunting/_index.md b/content/docs/hunting/_index.md index 2d6e6133cb96..0790cec16453 100644 --- a/content/docs/hunting/_index.md +++ b/content/docs/hunting/_index.md @@ -1,4 +1,5 @@ --- +icon: cursor-click title: "Hunting" date: 2021-06-09T04:13:25Z last_reviewed: 2025-12-29 diff --git a/content/docs/notebooks/_index.md b/content/docs/notebooks/_index.md index 7b09e1e0c3ac..c301fd8fe7a1 100644 --- a/content/docs/notebooks/_index.md +++ b/content/docs/notebooks/_index.md @@ -1,4 +1,5 @@ --- +icon: book-open title: Notebooks date: 2021-06-11T15:32:04Z last_reviewed: 2026-06-10 diff --git a/content/docs/overview/_index.md b/content/docs/overview/_index.md index 26d852b77a7b..e52a6a66e388 100644 --- a/content/docs/overview/_index.md +++ b/content/docs/overview/_index.md @@ -4,6 +4,7 @@ menutitle = "Velociraptor Overview" date = 2021-06-09T02:33:37Z weight = 5 chapter = false +icon = "globe" +++ > [!NOTE] diff --git a/content/docs/overview/support/index.md b/content/docs/overview/support/index.md index 439548dd5418..53c1be5d6e9d 100644 --- a/content/docs/overview/support/index.md +++ b/content/docs/overview/support/index.md @@ -1,6 +1,7 @@ --- menutitle: "Support Policy" title: "The Velociraptor Support Policy" +date: 2021-12-20 weight: 10 draft: false description: | diff --git a/content/docs/server_automation/_index.md b/content/docs/server_automation/_index.md index 8f3efeec2f89..10795fc968bb 100644 --- a/content/docs/server_automation/_index.md +++ b/content/docs/server_automation/_index.md @@ -1,4 +1,5 @@ --- +icon: cog title: "Server Automation" date: 2021-06-30T12:31:08Z draft: false diff --git a/content/docs/sigma/index.md b/content/docs/sigma/index.md index 6f54cc8f6d34..c7f7762a6459 100644 --- a/content/docs/sigma/index.md +++ b/content/docs/sigma/index.md @@ -1,4 +1,5 @@ --- +icon: shield-check menutitle: "Sigma rules" title: "Sigma rules" date: 2025-05-12 diff --git a/content/docs/troubleshooting/_index.md b/content/docs/troubleshooting/_index.md index 26fa2ae5be2a..bc340de93355 100644 --- a/content/docs/troubleshooting/_index.md +++ b/content/docs/troubleshooting/_index.md @@ -1,4 +1,5 @@ --- +icon: adjustments title: Troubleshooting Guide menutitle: Troubleshooting date: 2025-02-18 diff --git a/content/docs/troubleshooting/debugging/client/_index.md b/content/docs/troubleshooting/debugging/client/_index.md index 283a25661178..eb52006e6fd8 100644 --- a/content/docs/troubleshooting/debugging/client/_index.md +++ b/content/docs/troubleshooting/debugging/client/_index.md @@ -1,5 +1,6 @@ --- title: "Client" +date: 2025-03-28 description: "Profiles present only on the client" weight: 20 aliases: diff --git a/content/docs/troubleshooting/debugging/client/client_flows/index.md b/content/docs/troubleshooting/debugging/client/client_flows/index.md index 75d110d4321c..1188f8371f3d 100644 --- a/content/docs/troubleshooting/debugging/client/client_flows/index.md +++ b/content/docs/troubleshooting/debugging/client/client_flows/index.md @@ -1,5 +1,6 @@ --- title: "Flows" +date: 2025-03-28 description: Report the state of the client's flow manager weight: 50 aliases: diff --git a/content/docs/troubleshooting/debugging/client/client_monitoring/index.md b/content/docs/troubleshooting/debugging/client/client_monitoring/index.md index 69f801913e3e..c61570741ef6 100644 --- a/content/docs/troubleshooting/debugging/client/client_monitoring/index.md +++ b/content/docs/troubleshooting/debugging/client/client_monitoring/index.md @@ -1,5 +1,6 @@ --- title: "Monitoring" +date: 2025-03-28 weight: 10 description: Report stats on client monitoring artifacts aliases: diff --git a/content/docs/troubleshooting/debugging/global/_index.md b/content/docs/troubleshooting/debugging/global/_index.md index 4ba4dc1b465f..26ba358fb250 100644 --- a/content/docs/troubleshooting/debugging/global/_index.md +++ b/content/docs/troubleshooting/debugging/global/_index.md @@ -1,5 +1,6 @@ --- title: "Global" +date: 2025-09-29 description: "Profiles present on the server or client" weight: 20 --- diff --git a/content/docs/troubleshooting/debugging/global/datastore/_index.md b/content/docs/troubleshooting/debugging/global/datastore/_index.md index 9ffbed1980ec..3b01865e2c67 100644 --- a/content/docs/troubleshooting/debugging/global/datastore/_index.md +++ b/content/docs/troubleshooting/debugging/global/datastore/_index.md @@ -1,5 +1,6 @@ --- title: "Datastore" +date: 2025-09-29 weight: 20 description: Profiles related to the server's datastore. --- diff --git a/content/docs/troubleshooting/debugging/global/datastore/replication/index.md b/content/docs/troubleshooting/debugging/global/datastore/replication/index.md index 825d106afa2f..c43103a22987 100644 --- a/content/docs/troubleshooting/debugging/global/datastore/replication/index.md +++ b/content/docs/troubleshooting/debugging/global/datastore/replication/index.md @@ -1,5 +1,6 @@ --- title: "Replication" +date: 2025-09-29 weight: 10 description: Report current replication connections between master and minion. --- diff --git a/content/docs/troubleshooting/debugging/global/services/_index.md b/content/docs/troubleshooting/debugging/global/services/_index.md index 765a2594d469..f5c45e90c485 100644 --- a/content/docs/troubleshooting/debugging/global/services/_index.md +++ b/content/docs/troubleshooting/debugging/global/services/_index.md @@ -1,5 +1,6 @@ --- title: "Services" +date: 2025-03-28 weight: 50 description: "Velociraptor global services" aliases: diff --git a/content/docs/troubleshooting/debugging/global/services/export/index.md b/content/docs/troubleshooting/debugging/global/services/export/index.md index 8f2fc02c6c81..cbc3a4eccf04 100644 --- a/content/docs/troubleshooting/debugging/global/services/export/index.md +++ b/content/docs/troubleshooting/debugging/global/services/export/index.md @@ -1,5 +1,6 @@ --- title: "ExportContainers" +date: 2025-03-28 weight: 10 description: Report the state of current exports aliases: diff --git a/content/docs/troubleshooting/debugging/global/services/open_close/index.md b/content/docs/troubleshooting/debugging/global/services/open_close/index.md index f79447d6e64d..67f12458a29f 100644 --- a/content/docs/troubleshooting/debugging/global/services/open_close/index.md +++ b/content/docs/troubleshooting/debugging/global/services/open_close/index.md @@ -1,5 +1,6 @@ --- title: "Open-close" +date: 2025-09-29 weight: 40 description: Track open items that should be closed. aliases: diff --git a/content/docs/troubleshooting/debugging/global/services/tempfiles/index.md b/content/docs/troubleshooting/debugging/global/services/tempfiles/index.md index 2c6171937f70..27ab91ab2999 100644 --- a/content/docs/troubleshooting/debugging/global/services/tempfiles/index.md +++ b/content/docs/troubleshooting/debugging/global/services/tempfiles/index.md @@ -1,5 +1,6 @@ --- title: "tempfiles" +date: 2025-03-28 weight: 50 description: Track tempfiles used by the process. --- diff --git a/content/docs/troubleshooting/debugging/global/services/throttler/index.md b/content/docs/troubleshooting/debugging/global/services/throttler/index.md index a5834d2b76e4..715e864fc00d 100644 --- a/content/docs/troubleshooting/debugging/global/services/throttler/index.md +++ b/content/docs/troubleshooting/debugging/global/services/throttler/index.md @@ -1,5 +1,6 @@ --- title: "Throttler" +date: 2025-03-28 weight: 20 description: Track operations of the Throttler aliases: diff --git a/content/docs/troubleshooting/debugging/global/services/user_manager/index.md b/content/docs/troubleshooting/debugging/global/services/user_manager/index.md index 31cb15411452..b76e1fb1f786 100644 --- a/content/docs/troubleshooting/debugging/global/services/user_manager/index.md +++ b/content/docs/troubleshooting/debugging/global/services/user_manager/index.md @@ -1,5 +1,6 @@ --- title: "User Manager" +date: 2025-09-29 weight: 30 description: Reporting information about current users registered on the system. --- diff --git a/content/docs/troubleshooting/debugging/global/services/worker/index.md b/content/docs/troubleshooting/debugging/global/services/worker/index.md index afbd40219a92..d3d4a0b274f0 100644 --- a/content/docs/troubleshooting/debugging/global/services/worker/index.md +++ b/content/docs/troubleshooting/debugging/global/services/worker/index.md @@ -1,5 +1,6 @@ --- title: "worker" +date: 2025-09-29 weight: 60 description: Reporting information about current worker tasks. --- diff --git a/content/docs/troubleshooting/debugging/global/vql/_index.md b/content/docs/troubleshooting/debugging/global/vql/_index.md index da6e862d6b56..2a1a01d9e919 100644 --- a/content/docs/troubleshooting/debugging/global/vql/_index.md +++ b/content/docs/troubleshooting/debugging/global/vql/_index.md @@ -1,5 +1,6 @@ --- title: "VQL" +date: 2025-09-29 weight: 50 description: Track state of various VQL plugins and queries. aliases: diff --git a/content/docs/troubleshooting/debugging/global/vql/plugins/_index.md b/content/docs/troubleshooting/debugging/global/vql/plugins/_index.md index f010711043d4..681bc17986bb 100644 --- a/content/docs/troubleshooting/debugging/global/vql/plugins/_index.md +++ b/content/docs/troubleshooting/debugging/global/vql/plugins/_index.md @@ -1,5 +1,6 @@ --- title: "Plugins" +date: 2025-09-29 description: See plugin-specific information for certain VQL plugins. weight: 20 aliases: diff --git a/content/docs/troubleshooting/debugging/global/vql/plugins/etw/index.md b/content/docs/troubleshooting/debugging/global/vql/plugins/etw/index.md index 41aea137cf7e..29f02ec5ca32 100644 --- a/content/docs/troubleshooting/debugging/global/vql/plugins/etw/index.md +++ b/content/docs/troubleshooting/debugging/global/vql/plugins/etw/index.md @@ -1,5 +1,6 @@ --- title: "ETW" +date: 2025-03-29 weight: 10 description: Shows the current state of the ETW subsystem on Windows aliases: diff --git a/content/docs/troubleshooting/debugging/global/vql/plugins/glob/index.md b/content/docs/troubleshooting/debugging/global/vql/plugins/glob/index.md index fed9629f617d..edec6e18373a 100644 --- a/content/docs/troubleshooting/debugging/global/vql/plugins/glob/index.md +++ b/content/docs/troubleshooting/debugging/global/vql/plugins/glob/index.md @@ -1,5 +1,6 @@ --- title: Glob +date: 2025-03-28 description: Track current Glob operations weight: 20 aliases: diff --git a/content/docs/troubleshooting/debugging/global/vql/plugins/ntfs/index.md b/content/docs/troubleshooting/debugging/global/vql/plugins/ntfs/index.md index f01e00642a52..c1487e1aa9c1 100644 --- a/content/docs/troubleshooting/debugging/global/vql/plugins/ntfs/index.md +++ b/content/docs/troubleshooting/debugging/global/vql/plugins/ntfs/index.md @@ -1,5 +1,6 @@ --- title: NTFS Cache +date: 2025-09-29 description: Track NTFS caches weight: 30 --- diff --git a/content/docs/troubleshooting/debugging/global/vql/plugins/process/index.md b/content/docs/troubleshooting/debugging/global/vql/plugins/process/index.md index 48105888fd12..19953cae692c 100644 --- a/content/docs/troubleshooting/debugging/global/vql/plugins/process/index.md +++ b/content/docs/troubleshooting/debugging/global/vql/plugins/process/index.md @@ -1,5 +1,6 @@ --- title: Process Tracker +date: 2025-09-29 description: Report process tracker stats weight: 70 --- diff --git a/content/docs/troubleshooting/debugging/global/vql/plugins/sigma/index.md b/content/docs/troubleshooting/debugging/global/vql/plugins/sigma/index.md index 51c0b9b2d5d5..0a6f1160d7ae 100644 --- a/content/docs/troubleshooting/debugging/global/vql/plugins/sigma/index.md +++ b/content/docs/troubleshooting/debugging/global/vql/plugins/sigma/index.md @@ -1,5 +1,6 @@ --- title: Sigma Tracker +date: 2025-03-28 description: Track current Sigma operations weight: 40 aliases: diff --git a/content/docs/troubleshooting/debugging/global/vql/plugins/sqlite/index.md b/content/docs/troubleshooting/debugging/global/vql/plugins/sqlite/index.md index c1cdcab9701f..09f242e8c88a 100644 --- a/content/docs/troubleshooting/debugging/global/vql/plugins/sqlite/index.md +++ b/content/docs/troubleshooting/debugging/global/vql/plugins/sqlite/index.md @@ -1,5 +1,6 @@ --- title: Sqlite +date: 2025-03-29 description: Track SQLite handles used by the process. weight: 70 aliases: diff --git a/content/docs/troubleshooting/debugging/global/vql/plugins/windows_event/index.md b/content/docs/troubleshooting/debugging/global/vql/plugins/windows_event/index.md index 047ad0c3e115..242a9b39e4fe 100644 --- a/content/docs/troubleshooting/debugging/global/vql/plugins/windows_event/index.md +++ b/content/docs/troubleshooting/debugging/global/vql/plugins/windows_event/index.md @@ -1,5 +1,6 @@ --- title: Windows Event Log Watcher +date: 2025-03-28 weight: 50 description: Records Statistics about the Windows Event Log Watcher Subsystem. aliases: diff --git a/content/docs/troubleshooting/debugging/global/vql/plugins/zip/index.md b/content/docs/troubleshooting/debugging/global/vql/plugins/zip/index.md index 2f1eaa3ce333..4d8d050fb9b8 100644 --- a/content/docs/troubleshooting/debugging/global/vql/plugins/zip/index.md +++ b/content/docs/troubleshooting/debugging/global/vql/plugins/zip/index.md @@ -1,5 +1,6 @@ --- title: "Zip" +date: 2025-09-29 description: Reference counting for open Zip files. weight: 60 --- diff --git a/content/docs/troubleshooting/debugging/global/vql/queries/_index.md b/content/docs/troubleshooting/debugging/global/vql/queries/_index.md index 38457a1f3623..2693b1e0682b 100644 --- a/content/docs/troubleshooting/debugging/global/vql/queries/_index.md +++ b/content/docs/troubleshooting/debugging/global/vql/queries/_index.md @@ -1,5 +1,6 @@ --- title: "Queries" +date: 2025-09-29 description: See currently and recently running VQL queries. weight: 10 aliases: diff --git a/content/docs/troubleshooting/debugging/global/vql/queries/active_queries/index.md b/content/docs/troubleshooting/debugging/global/vql/queries/active_queries/index.md index c8c31f66a329..2e781d75b46a 100644 --- a/content/docs/troubleshooting/debugging/global/vql/queries/active_queries/index.md +++ b/content/docs/troubleshooting/debugging/global/vql/queries/active_queries/index.md @@ -1,5 +1,6 @@ --- title: "Active Queries" +date: 2025-09-29 description: Report Currently Active queries. weight: 10 --- diff --git a/content/docs/troubleshooting/debugging/global/vql/queries/plugin_monitor/index.md b/content/docs/troubleshooting/debugging/global/vql/queries/plugin_monitor/index.md index c0344df90a55..52a104fa6adc 100644 --- a/content/docs/troubleshooting/debugging/global/vql/queries/plugin_monitor/index.md +++ b/content/docs/troubleshooting/debugging/global/vql/queries/plugin_monitor/index.md @@ -1,5 +1,6 @@ --- title: "Plugin Monitor" +date: 2025-03-28 description: See currently running VQL plugins. weight: 10 --- diff --git a/content/docs/troubleshooting/debugging/global/vql/queries/recent_queries/index.md b/content/docs/troubleshooting/debugging/global/vql/queries/recent_queries/index.md index 41cf04d065ea..5faa80ce9f52 100644 --- a/content/docs/troubleshooting/debugging/global/vql/queries/recent_queries/index.md +++ b/content/docs/troubleshooting/debugging/global/vql/queries/recent_queries/index.md @@ -1,5 +1,6 @@ --- title: "Recent Queries" +date: 2025-09-29 description: Report Currently Active queries. weight: 30 --- diff --git a/content/docs/troubleshooting/debugging/internal/_index.md b/content/docs/troubleshooting/debugging/internal/_index.md index 9938b2aec469..c873190b3ef7 100644 --- a/content/docs/troubleshooting/debugging/internal/_index.md +++ b/content/docs/troubleshooting/debugging/internal/_index.md @@ -1,5 +1,6 @@ --- title: "Internal" +date: 2025-03-28 description: "Profiles provided by Golang" weight: 10 aliases: diff --git a/content/docs/troubleshooting/debugging/internal/go_profiles/index.md b/content/docs/troubleshooting/debugging/internal/go_profiles/index.md index 9461cf91e94c..ab8cb2f541c0 100644 --- a/content/docs/troubleshooting/debugging/internal/go_profiles/index.md +++ b/content/docs/troubleshooting/debugging/internal/go_profiles/index.md @@ -1,5 +1,6 @@ --- title: "Golang" +date: 2025-03-28 weight: 20 description: Show built in Go Profiles aliases: diff --git a/content/docs/troubleshooting/debugging/internal/metrics/index.md b/content/docs/troubleshooting/debugging/internal/metrics/index.md index 8386cdba6483..df3e4334ff33 100644 --- a/content/docs/troubleshooting/debugging/internal/metrics/index.md +++ b/content/docs/troubleshooting/debugging/internal/metrics/index.md @@ -1,5 +1,6 @@ --- title: "Metrics" +date: 2025-03-28 weight: 10 description: Report all the current process running metrics. aliases: diff --git a/content/docs/troubleshooting/debugging/org/_index.md b/content/docs/troubleshooting/debugging/org/_index.md index 9c44f2d360d5..d56885ff2498 100644 --- a/content/docs/troubleshooting/debugging/org/_index.md +++ b/content/docs/troubleshooting/debugging/org/_index.md @@ -1,5 +1,6 @@ --- title: Org +date: 2025-09-29 description: Profiles associated with org services. weight: 20 --- diff --git a/content/docs/troubleshooting/debugging/org/services/_index.md b/content/docs/troubleshooting/debugging/org/services/_index.md index a0caf4599b9f..bcf78fecf3ee 100644 --- a/content/docs/troubleshooting/debugging/org/services/_index.md +++ b/content/docs/troubleshooting/debugging/org/services/_index.md @@ -1,5 +1,6 @@ --- title: "Services" +date: 2025-09-29 weight: 10 summary: "" --- diff --git a/content/docs/troubleshooting/debugging/org/services/broadcast_service/index.md b/content/docs/troubleshooting/debugging/org/services/broadcast_service/index.md index 5e34842121c6..9998db3157e4 100644 --- a/content/docs/troubleshooting/debugging/org/services/broadcast_service/index.md +++ b/content/docs/troubleshooting/debugging/org/services/broadcast_service/index.md @@ -1,5 +1,6 @@ --- title: "Broadcast" +date: 2025-09-29 weight: 10 description: Track generators installed via the generator() plugin. --- diff --git a/content/docs/troubleshooting/debugging/org/services/notifier/index.md b/content/docs/troubleshooting/debugging/org/services/notifier/index.md index c437c46a268a..33e273210e3d 100644 --- a/content/docs/troubleshooting/debugging/org/services/notifier/index.md +++ b/content/docs/troubleshooting/debugging/org/services/notifier/index.md @@ -1,5 +1,6 @@ --- title: "Notifier" +date: 2025-09-29 weight: 40 description: Information about directly connected clients. --- diff --git a/content/docs/troubleshooting/debugging/org/services/queue_manager/index.md b/content/docs/troubleshooting/debugging/org/services/queue_manager/index.md index cc75b918a168..18eac8792a6a 100644 --- a/content/docs/troubleshooting/debugging/org/services/queue_manager/index.md +++ b/content/docs/troubleshooting/debugging/org/services/queue_manager/index.md @@ -1,5 +1,6 @@ --- title: "QueueManager" +date: 2025-09-29 weight: 20 description: Report the current states of server artifact event queues. --- diff --git a/content/docs/troubleshooting/debugging/org/services/vfs_service/index.md b/content/docs/troubleshooting/debugging/org/services/vfs_service/index.md index f2a79b0491f9..8bcee75b947b 100644 --- a/content/docs/troubleshooting/debugging/org/services/vfs_service/index.md +++ b/content/docs/troubleshooting/debugging/org/services/vfs_service/index.md @@ -1,5 +1,6 @@ --- title: "VFS" +date: 2025-09-29 weight: 20 description: The VFS service post processes results from VFS operations. --- diff --git a/content/docs/vql/_index.md b/content/docs/vql/_index.md index 05df82a73a91..0ff4dc9e4b9f 100644 --- a/content/docs/vql/_index.md +++ b/content/docs/vql/_index.md @@ -1,4 +1,5 @@ --- +icon: code title: "VQL" date: 2021-06-11T05:55:46Z draft: false diff --git a/content/docs/vql/vql_reference/index.md b/content/docs/vql/vql_reference/index.md index 5070b73f85ea..3e6d33243e45 100644 --- a/content/docs/vql/vql_reference/index.md +++ b/content/docs/vql/vql_reference/index.md @@ -8,7 +8,6 @@ noDisqus: true no_edit: true disableToc: false chapter: false -pre: --- {{% include-page "/vql_reference/" %}} diff --git a/content/downloads/_index.md b/content/downloads/_index.md index 04b5fc0796f0..ff8e0d5318e9 100644 --- a/content/downloads/_index.md +++ b/content/downloads/_index.md @@ -9,7 +9,6 @@ date: 2021-06-23T08:29:57Z draft: false weight: 25 no_children: true -pre: release: 0.77.2 base_release: 0.77.2 arches: diff --git a/content/downloads/previous_downloads/index.md b/content/downloads/previous_downloads/index.md index 28a7854a53b7..c3a5c0eba529 100644 --- a/content/downloads/previous_downloads/index.md +++ b/content/downloads/previous_downloads/index.md @@ -1,10 +1,10 @@ --- +type: wide title: "Downloads" date: 2021-06-23T08:29:57Z draft: false weight: 25 no_children: true -pre: release: 0.76.7 base_release: 0.76.7 arches: diff --git a/content/downloads/rc_downloads/index.md b/content/downloads/rc_downloads/index.md index c0e6efd3a95c..05ef3f2c0b51 100644 --- a/content/downloads/rc_downloads/index.md +++ b/content/downloads/rc_downloads/index.md @@ -1,10 +1,10 @@ --- +type: wide title: "Release Candidates" date: 2021-06-23T08:29:57Z draft: false weight: 25 no_children: true -pre: release: 0.77.1-rc1 base_release: 0.77.1-rc1 arches: diff --git a/content/exchange/_index.md b/content/exchange/_index.md index cf55a1b849e5..1c3745e6ba2d 100644 --- a/content/exchange/_index.md +++ b/content/exchange/_index.md @@ -8,7 +8,6 @@ date: 2021-06-12T14:03:59Z last_reviewed: 2026-07-26 draft: false weight: 150 -pre: no_edit: true sitemap: disable: true diff --git a/content/knowledge_base/_index.md b/content/knowledge_base/_index.md index e94dd0c9bd10..a60307d9eaa3 100644 --- a/content/knowledge_base/_index.md +++ b/content/knowledge_base/_index.md @@ -4,9 +4,9 @@ cascade: type: docs menutitle: "Knowledge Base" title: "Knowledge Base" +date: 2022-03-21 draft: false weight: 250 -pre: no_edit: true disableToc: false no_children: true diff --git a/content/presentations/_index.md b/content/presentations/_index.md index eb0f0c0d5b08..f83b57ef85d8 100644 --- a/content/presentations/_index.md +++ b/content/presentations/_index.md @@ -4,7 +4,6 @@ title: "Presentations" weight: 270 no_children: true no_edit: true -pre: description: | The following are various presentations and events that featured Velociraptor in some way. diff --git a/content/rss/index.md b/content/rss/index.md index a7c1f03cc48a..715a2b81b1c7 100644 --- a/content/rss/index.md +++ b/content/rss/index.md @@ -3,6 +3,7 @@ sidebar: exclude: true menutitle: "RSS" title: "RSS Feeds" +date: 2022-03-26 draft: false weight: 250 no_edit: true diff --git a/content/search/index.md b/content/search/index.md index bca81d0e5ff9..888c519a40f6 100644 --- a/content/search/index.md +++ b/content/search/index.md @@ -8,7 +8,6 @@ draft: false noDisqus: true noTitle: true weight: 400 -pre: "" --- {{< search >}} diff --git a/content/training/_index.md b/content/training/_index.md index d735e308b4b7..6f8348a247be 100644 --- a/content/training/_index.md +++ b/content/training/_index.md @@ -5,7 +5,6 @@ title: "Training Resources" date: 2021-06-12T14:03:59Z draft: false weight: 260 -pre: description: | ## Scheduled courses --- diff --git a/content/training/comparisons/_index.md b/content/training/comparisons/_index.md index 2c458a0e8cf2..526ab40dd756 100644 --- a/content/training/comparisons/_index.md +++ b/content/training/comparisons/_index.md @@ -1,5 +1,6 @@ --- title: "Comparisons" +date: 2026-03-26 description: | Velociraptor is a powerful forensic tool. These pages compare Velociraptor to other popular tools. @@ -45,4 +46,4 @@ The following pages serve a number of goals: ## Tool comparison -{{% children %}} +{{% children grid-cols=1 %}} diff --git a/content/training/comparisons/eztools/index.md b/content/training/comparisons/eztools/index.md index 09c68cf6b460..bb1ac7238bb3 100644 --- a/content/training/comparisons/eztools/index.md +++ b/content/training/comparisons/eztools/index.md @@ -1,5 +1,7 @@ --- + +icon: cursor-click title: "EZ Tools" menutitle: EZ Tools --- diff --git a/content/training/comparisons/raw_copy/index.md b/content/training/comparisons/raw_copy/index.md index b5cbf387a674..945cd345ada4 100644 --- a/content/training/comparisons/raw_copy/index.md +++ b/content/training/comparisons/raw_copy/index.md @@ -1,5 +1,7 @@ --- + +icon: copy title: "RawCopy" menutitle: RawCopy --- diff --git a/content/training/playbooks/_index.md b/content/training/playbooks/_index.md index daa234e12b50..620e541f3377 100644 --- a/content/training/playbooks/_index.md +++ b/content/training/playbooks/_index.md @@ -4,7 +4,6 @@ title: "Playbooks" date: 2024-06-12T14:03:59Z draft: false weight: 150 -pre: no_edit: true disableToc: false no_children: true @@ -24,4 +23,4 @@ to know where to start. This page aims to help newcomers to Velociraptor by presenting a set of playbooks to use when faced with certain tasks. -{{% children description=true style="h2" %}} +{{% children description=true grid-cols=1 %}} diff --git a/content/training/playbooks/finding_files/index.md b/content/training/playbooks/finding_files/index.md index 659d90bb628a..b9700af64719 100644 --- a/content/training/playbooks/finding_files/index.md +++ b/content/training/playbooks/finding_files/index.md @@ -1,4 +1,5 @@ --- +icon: search title: "Finding Files" date: 2025-03-29 weight: 50 diff --git a/content/training/playbooks/preservation/index.md b/content/training/playbooks/preservation/index.md index c846391d544f..762886626d58 100644 --- a/content/training/playbooks/preservation/index.md +++ b/content/training/playbooks/preservation/index.md @@ -1,4 +1,5 @@ --- +icon: archive title: "Preserving Forensic Evidence" date: 2024-08-08 summary: | diff --git a/content/training/playbooks/triage-logs/index.md b/content/training/playbooks/triage-logs/index.md index 651e506f4614..bea577688a9d 100644 --- a/content/training/playbooks/triage-logs/index.md +++ b/content/training/playbooks/triage-logs/index.md @@ -1,4 +1,5 @@ --- +icon: document-text title: "Triaging Logs" date: 2024-08-08 summary: | diff --git a/content/vql_reference/_index.md b/content/vql_reference/_index.md index c6743c930288..c235279c50bc 100644 --- a/content/vql_reference/_index.md +++ b/content/vql_reference/_index.md @@ -14,7 +14,6 @@ no_edit: true disableToc: false noTitle: true chapter: false -pre: head:
description: | {{% expand "This page lists all the plugins, functions and accessors which are available in Velociraptor." %}} diff --git a/layouts/shortcodes/children.html b/layouts/shortcodes/children.html index dddb68724e7f..b22219d75be9 100644 --- a/layouts/shortcodes/children.html +++ b/layouts/shortcodes/children.html @@ -1,6 +1,8 @@ {{- /* Port of the learn-theme children shortcode: lists child pages of the current section. Default style renders Hextra-style link cards; - style="hN" preserves the old heading-based rendering (used for TOC). */ -}} + style="hN" preserves the old heading-based rendering (used for TOC). + Cards may show an icon taken from each child page's `icon:` front + matter parameter (a name from the theme's data/icons.yaml set). */ -}} {{- $_hugo_config := `{ "version": 1 }` -}} {{- $showhidden := .Get "showhidden" -}} {{- $style := .Get "style" | default "li" -}} @@ -45,6 +47,11 @@
+ {{- with .Params.icon -}} + + {{- partial "utils/icon.html" (dict "name" . "attributes" "height=1.5rem") -}} + + {{- end -}} {{ .Title }} {{ partial "utils/icon.html" (dict "name" "chevron-right") }} diff --git a/layouts/wide/single.html b/layouts/wide/single.html new file mode 100644 index 000000000000..fce2810cf445 --- /dev/null +++ b/layouts/wide/single.html @@ -0,0 +1,12 @@ +{{ define "main" }} +
+ {{ partial "sidebar.html" (dict "context" . "disableSidebar" true "displayPlaceholder" false) }} +
+
+ {{ if .Title }}

{{ .Title }}

{{ end }} +
+ {{ .Content }} +
+
+
+{{ end }} \ No newline at end of file From 1b8de3b901ef2654427338528aa5ba5accff4a32 Mon Sep 17 00:00:00 2001 From: predictiple Date: Mon, 21 Sep 2026 11:02:55 +0200 Subject: [PATCH 2/6] Pin Vale to 3.21.0 to fix CI failing on long-unchanged content (#1310) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit CI just started failing on Vale — not because of the content, but because `version: latest` recently pulled in Vale 3.22.0. 3.22.0 introduced a tokenizer regression that merges words across markdown links / inline HTML: - `[Carbon Black](...)allows` → "Blackallows" - `Publishedon` → "Publishedon" None of the flagged files changed; the tool did. Confirmed locally with the exact CI binaries: 3.21.0 passes, 3.22.0 fails. This pins Vale to 3.21.0 so we can bump deliberately once it's fixed upstream. --- .github/workflows/verify.yaml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/.github/workflows/verify.yaml b/.github/workflows/verify.yaml index 67eec2eb93af..57df54442408 100644 --- a/.github/workflows/verify.yaml +++ b/.github/workflows/verify.yaml @@ -20,6 +20,12 @@ jobs: # Set to true when we want to start having errors fail the pipeline. fail_on_error: true + # Pin the Vale version. 3.22.0 regressed inline-HTML/markdown-link + # tokenization (concatenating adjacent words into single tokens, + # e.g. "Publishedon" -> "Publishedon"), failing the + # build on long-unchanged content. Bump intentionally. + version: 3.21.0 + # Only check lines touched by the PR to avoid reviewdog's # "too many annotations" failures on full-corpus scans. filter_mode: added From e3d7b2d35bfe93f98fd23634d6adfcc75ec6f6e5 Mon Sep 17 00:00:00 2001 From: predictiple Date: Tue, 22 Sep 2026 12:46:44 +0200 Subject: [PATCH 3/6] Fixes to anchor links and site search (#1311) --- assets/css/custom.css | 155 +++++------- assets/js/heading-anchor-copy.js | 62 +++++ assets/js/search.js | 237 ++++++++++++++---- layouts/_partials/scripts.html | 3 + .../scripts/heading-anchor-copy.html | 7 + layouts/_partials/section-exclusions.html | 6 + layouts/_partials/section-names.html | 20 ++ layouts/baseof.html | 25 +- layouts/shortcodes/search.html | 55 +++- pagefind.yml | 16 ++ 10 files changed, 418 insertions(+), 168 deletions(-) create mode 100644 assets/js/heading-anchor-copy.js create mode 100644 layouts/_partials/scripts/heading-anchor-copy.html create mode 100644 layouts/_partials/section-exclusions.html create mode 100644 layouts/_partials/section-names.html create mode 100644 pagefind.yml diff --git a/assets/css/custom.css b/assets/css/custom.css index 8702f532d488..501e3a9d2c38 100644 --- a/assets/css/custom.css +++ b/assets/css/custom.css @@ -1234,82 +1234,42 @@ html.dark #pagefind-site-search .pagefind-ui__result-tag { margin-left: 0.375rem; } -/* --- Pagefind filter panel (/search/ page) --- - Once the index carries data-pagefind-filter values, the old PagefindUI - renders a checkbox sidebar (fieldset.pagefind-ui__filter-panel) next to - the results. On this site the /search/ column (~768px) wraps the drawer, - so the panel renders as a collapsible "Section" accordion above the - results - style it as such (border-bottom, no right rules). */ -#pagefind-site-search .pagefind-ui__filter-panel { - margin-top: 1rem; -} -#pagefind-site-search .pagefind-ui__filter-panel-label { - font-size: 0.75rem; - font-weight: 700; - text-transform: uppercase; - letter-spacing: 0.05em; - color: var(--hx-color-neutral-500, #737373); -} -#pagefind-site-search .pagefind-ui__filter-block { - border-bottom: 1px solid var(--hx-color-neutral-200, #e5e5e5); -} -#pagefind-site-search .pagefind-ui__filter-name { - font-size: 0.875rem; - font-weight: 600; - color: var(--hx-color-neutral-900, #171717); -} -html.dark #pagefind-site-search .pagefind-ui__filter-name { - color: var(--hx-color-neutral-100, #f5f5f5); -} -#pagefind-site-search .pagefind-ui__filter-group { - gap: 0.625rem; - padding-top: 0.875rem; -} -#pagefind-site-search .pagefind-ui__filter-value { - display: flex; - align-items: center; - gap: 0.5rem; -} -#pagefind-site-search .pagefind-ui__filter-label { - font-size: 0.875rem; - color: var(--hx-color-neutral-700, #404040); -} -html.dark #pagefind-site-search .pagefind-ui__filter-label { - color: var(--hx-color-neutral-300, #d4d4d4); -} -#pagefind-site-search .pagefind-ui__filter-checkbox { - border: 1px solid var(--hx-color-neutral-300, #d4d4d4); - background-color: transparent; - border-radius: 4px; -} -#pagefind-site-search .pagefind-ui__filter-checkbox:checked { - background-color: var(--hx-color-primary-600, #2563eb); - border-color: var(--hx-color-primary-600, #2563eb); -} - -/* The search modal keeps the tag chips but not the filter sidebar - (filtering is a /search/ page feature). */ +/* --- /search/ page: native Pagefind filter panel is hidden --- + PagefindUI renders a checkbox "Section"/"Tags" filter panel per query once + the index carries data-pagefind-filter values. On this site the /search/ + column (~768px) would wrap it next to the results, and the shortcode already + renders its own server-side "Filter by Section" / "Filter by Tag" + accordions (visible before any query is typed). The native panel is + therefore hidden and used only as a source of truth: search.js reads its + per-value counts to prune the accordion pills and toggles its checkboxes + on pill click. The search modal keeps the tag chips but not the filter + sidebar (filtering is a /search/ page feature). */ +#pagefind-site-search .pagefind-ui__filter-panel, #pagefind-ui .pagefind-ui__filter-panel { display: none; } +/* The native filter blocks are left in the DOM (search.js reads their + counts) but must never paint. */ +#pagefind-site-search .pagefind-ui__filter-block[hidden] { + display: none !important; +} -/* --- /search/ page: "Tags" accordion (shortcode renders the same - taxonomy listing as the /tags/ page; search.js moves it into the - filter panel, under the Section block). The svelte-scoped pagefind - rules don't cover this element, so it needs its own chrome here. - The rules are scoped to the element id so they apply both before the - search (as a sibling of the PagefindUI mount) and once it is moved - into the filter panel; id specificity also beats the pagefind - `.pagefind-ui--reset * { all: unset }` inside the UI root. */ +/* --- /search/ page: "Filter by Section" and "Filter by Tag" accordions + (shortcode renders both, with the full server-side lists, so they are + visible before any query). The pagefind rules don't cover these elements, + so they need their own chrome here. The rules are scoped to the element + ids so they apply independently of the PagefindUI mount; id specificity + also beats the pagefind `.pagefind-ui--reset * { all: unset }`. */ +#pagefind-site-sections, #pagefind-site-tags { cursor: default; margin-top: 0.75rem; } -/* Inside the panel, the filter-panel already carries margin-top — - reset so the accordion sits flush under the Section block. */ -#pagefind-site-search .pagefind-ui__filter-panel #pagefind-site-tags { - margin-top: 0; +/* Keep the accordions visually separate from the PagefindUI input below. */ +.search-box[data-site-search] #pagefind-site-search { + margin-top: 1rem; } +#pagefind-site-sections .search-sections-name, #pagefind-site-tags .search-tags-name { position: relative; cursor: pointer; @@ -1321,14 +1281,18 @@ html.dark #pagefind-site-search .pagefind-ui__filter-label { font-weight: 600; color: var(--hx-color-neutral-900, #171717); } +html.dark #pagefind-site-sections .search-sections-name, html.dark #pagefind-site-tags .search-tags-name { color: var(--hx-color-neutral-100, #f5f5f5); } +#pagefind-site-sections .search-sections-name::-webkit-details-marker, +#pagefind-site-sections .search-sections-name::marker, #pagefind-site-tags .search-tags-name::-webkit-details-marker, #pagefind-site-tags .search-tags-name::marker { display: none; } /* Same disclosure chevron as the Section blocks (border triangle). */ +#pagefind-site-sections .search-sections-name::after, #pagefind-site-tags .search-tags-name::after { content: ""; position: absolute; @@ -1341,21 +1305,29 @@ html.dark #pagefind-site-tags .search-tags-name { border-top: 0; transform: translateY(-70%) rotate(-45deg); } +#pagefind-site-sections[open] .search-sections-name::after, #pagefind-site-tags[open] .search-tags-name::after { transform: translateY(-70%) rotate(-225deg); } -/* Tag cloud: the panel column is narrow, so wrap instead of the /tags/ +/* Pill clouds: the panel column is narrow, so wrap instead of the /tags/ page's multi-column grid. */ +#pagefind-site-sections .search-sections-grid, #pagefind-site-tags .search-tags-grid { display: flex; flex-wrap: wrap; gap: 0.25rem 1.5rem; padding-top: 0.875rem; } -/* Filter-toggle pills in the /search/ Tags accordion. - Originally styled for elements; now rendered as + {{- end }} +
+ {{- with .Site.Taxonomies.tags.Alphabetical }}
- Tags + Filter by Tag
{{- range . }}
{{- end }} + \ No newline at end of file diff --git a/layouts/_partials/toc.html b/layouts/_partials/toc.html index a4f640c75840..29623bcb948a 100644 --- a/layouts/_partials/toc.html +++ b/layouts/_partials/toc.html @@ -7,8 +7,11 @@ {{- $backToTop := (T "backToTop") | default "Scroll to top" -}} +{{/* Floating collapse/expand controls: overlay buttons parked at the + article column's top-right corner, just below the navbar. Each is shown + in the matching state - the right-facing chevron collapses the column, + the left-facing one reopens it. They live outside the nav (a display:none + column would hide them along with the rest of the column) and float over + the article's edge via fixed positioning, so they stay reachable + mid-scroll. Styling is in assets/css/custom.css. */}} + + + {{/* TOC subheadings component. This is a recursive component that renders a list of headings. */}} {{- define "toc-subheading" -}} {{- $headings := .headings -}} diff --git a/layouts/partials/custom/head-end.html b/layouts/partials/custom/head-end.html index 98e79dcb7dc4..6867397d72a3 100644 --- a/layouts/partials/custom/head-end.html +++ b/layouts/partials/custom/head-end.html @@ -38,4 +38,22 @@ if (!window.__sidebarScrollInit) d.classList.remove("sidebar-loading"); }, 2000); })(); + + +{{- /* Collapsed right TOC column (assets/js/toc-collapse.js): apply the + reader's persisted state before the page paints, so the column is + already hidden on first sight - the deferred script only handles clicks + from then on. localStorage reads are not available during + rendering (Hugo does not evaluate them), so this must live in an inline + script. */ -}} + \ No newline at end of file