From cde284e7470a798b52f01b19f683e4097b7207ad Mon Sep 17 00:00:00 2001 From: ArthurSonzogni Date: Fri, 30 May 2025 19:32:42 +0200 Subject: [PATCH 1/2] Doc: Add image headers. --- doc/getting-started.md | 2 ++ doc/header.html | 17 +++++++++++++++++ doc/installation.md | 3 +++ doc/module.md | 2 ++ 4 files changed, 24 insertions(+) diff --git a/doc/getting-started.md b/doc/getting-started.md index 74ac1be6f..eabf1b482 100644 --- a/doc/getting-started.md +++ b/doc/getting-started.md @@ -1,6 +1,8 @@ @page getting-started Getting Started @tableofcontents +![3edd56cb-3ebb-442c-b7da-dfa5a759f4eb](https://github.com/user-attachments/assets/ed1bc694-7b3f-487c-9fd3-801437a6460b) + # Install FTXUI To set up FTXUI in your project, follow the [installation guide](installation.html), which provides instructions for multiple build systems and package managers. diff --git a/doc/header.html b/doc/header.html index 1d1d368fa..b9b88b0d6 100644 --- a/doc/header.html +++ b/doc/header.html @@ -25,6 +25,23 @@ DoxygenAwesomeParagraphLink.init() DoxygenAwesomeInteractiveToc.init() DoxygenAwesomeTabs.init() + + window.addEventListener('DOMContentLoaded', function () { + document.querySelectorAll(".headertitle").forEach(div => { + if (div.textContent != "Getting Started" && + div.textContent != "Installation" && + div.textContent != "Modules" && + true) { + return; + } + div.style.display = "none"; + const img = document.querySelector("img.inline"); + img.style.transition = "all 1.0s ease-in-out"; + img.style.maxHeight = "40vh"; + img.style.maxWidth = "100%"; + img.style.objectFit = "contain"; + }); + }); $treeview $search diff --git a/doc/installation.md b/doc/installation.md index 32317ff12..4834f573a 100644 --- a/doc/installation.md +++ b/doc/installation.md @@ -1,6 +1,9 @@ + @page installation Installation @tableofcontents +![64c412f8-a29f-475f-8a2b-ffc662975a08](https://github.com/user-attachments/assets/ab5d7561-bae0-4f42-bd80-5e94bfd15e09) + ## Overview FTXUI can be integrated into your project using several build systems and package managers. diff --git a/doc/module.md b/doc/module.md index 64bc41c48..b76885aff 100644 --- a/doc/module.md +++ b/doc/module.md @@ -1,5 +1,7 @@ # Modules {#modules} +![66f79802-97b3-4b31-b3dd-e096095a0ab7](https://github.com/user-attachments/assets/9f964064-7cd5-421e-afb4-091256c5096e) + FTXUI is organized into three modules, each building upon the previous: 1. @subpage module-screen — low-level rendering From 2f0afe7b14e139363d6bb5d643e9a3c50dab3c93 Mon Sep 17 00:00:00 2001 From: ArthurSonzogni Date: Fri, 30 May 2025 20:13:47 +0200 Subject: [PATCH 2/2] Fix documentation image headers. --- doc/getting-started.md | 2 +- doc/header.html | 5 ++++- doc/installation.md | 2 +- doc/module.md | 2 +- 4 files changed, 7 insertions(+), 4 deletions(-) diff --git a/doc/getting-started.md b/doc/getting-started.md index eabf1b482..690586547 100644 --- a/doc/getting-started.md +++ b/doc/getting-started.md @@ -1,7 +1,7 @@ @page getting-started Getting Started @tableofcontents -![3edd56cb-3ebb-442c-b7da-dfa5a759f4eb](https://github.com/user-attachments/assets/ed1bc694-7b3f-487c-9fd3-801437a6460b) +![title-img](https://nsm09.casimages.com/img/2025/05/30//2505300816063242518595256.jpg) # Install FTXUI diff --git a/doc/header.html b/doc/header.html index b9b88b0d6..3a7e64d90 100644 --- a/doc/header.html +++ b/doc/header.html @@ -28,6 +28,8 @@ window.addEventListener('DOMContentLoaded', function () { document.querySelectorAll(".headertitle").forEach(div => { + + // Hide progressively the title. if (div.textContent != "Getting Started" && div.textContent != "Installation" && div.textContent != "Modules" && @@ -35,8 +37,9 @@ return; } div.style.display = "none"; + + // Show progressively the image. const img = document.querySelector("img.inline"); - img.style.transition = "all 1.0s ease-in-out"; img.style.maxHeight = "40vh"; img.style.maxWidth = "100%"; img.style.objectFit = "contain"; diff --git a/doc/installation.md b/doc/installation.md index 4834f573a..3a8ecdffd 100644 --- a/doc/installation.md +++ b/doc/installation.md @@ -2,7 +2,7 @@ @page installation Installation @tableofcontents -![64c412f8-a29f-475f-8a2b-ffc662975a08](https://github.com/user-attachments/assets/ab5d7561-bae0-4f42-bd80-5e94bfd15e09) +![title-img](https://nsm09.casimages.com/img/2025/05/30//2505300816063242518595255.jpg) ## Overview diff --git a/doc/module.md b/doc/module.md index b76885aff..cdf58eda3 100644 --- a/doc/module.md +++ b/doc/module.md @@ -1,6 +1,6 @@ # Modules {#modules} -![66f79802-97b3-4b31-b3dd-e096095a0ab7](https://github.com/user-attachments/assets/9f964064-7cd5-421e-afb4-091256c5096e) +![title-img](https://nsm09.casimages.com/img/2025/05/30//2505300816063242518595251.jpg) FTXUI is organized into three modules, each building upon the previous: