[clang-doc] Create a partial for the navbar (#171669)

evelez7 · web-flow · commit 3d1f04425a8f · 2025-12-11T17:07:55.000Z
Move navbar section to its own template to ensure consistency across
templates
diff --git a/clang-tools-extra/clang-doc/HTMLGenerator.cpp b/clang-tools-extra/clang-doc/HTMLGenerator.cpp
@@ -68,11 +68,14 @@ Error HTMLGenerator::setupTemplateFiles(const ClangDocContext &CDCtx) {
       ConvertToNative(CDCtx.MustacheTemplates.lookup("enum-template"));
   std::string HeadFilePath =
       ConvertToNative(CDCtx.MustacheTemplates.lookup("head-template"));
+  std::string NavbarFilePath =
+      ConvertToNative(CDCtx.MustacheTemplates.lookup("navbar-template"));
   std::vector<std::pair<StringRef, StringRef>> Partials = {
       {"Comments", CommentFilePath},
       {"FunctionPartial", FunctionFilePath},
       {"EnumPartial", EnumFilePath},
-      {"HeadPartial", HeadFilePath}};
+      {"HeadPartial", HeadFilePath},
+      {"NavbarPartial", NavbarFilePath}};
 
   if (Error Err = setupTemplate(NamespaceTemplate, NamespaceFilePath, Partials))
     return Err;
diff --git a/clang-tools-extra/clang-doc/assets/class-template.mustache b/clang-tools-extra/clang-doc/assets/class-template.mustache
@@ -9,25 +9,7 @@
 <html lang="en-US">
 {{>HeadPartial}}
 <body>
-    <nav class="navbar">
-        <div class="navbar__container">
-            {{#ProjectName}}
-            <div class="navbar__logo">
-                {{ProjectName}}
-            </div>
-            {{/ProjectName}}
-            <div class="navbar__menu">
-                <ul class="navbar__links">
-                    <li class="navbar__item">
-                        <a href="/" class="navbar__link">Namespace</a>
-                    </li>
-                    <li class="navbar__item">
-                        <a href="/" class="navbar__link">Class</a>
-                    </li>
-                </ul>
-            </div>
-        </div>
-    </nav>
+    {{>NavbarPartial}}
     <main>
         <div class="container">
             <div class="sidebar">
diff --git a/clang-tools-extra/clang-doc/assets/namespace-template.mustache b/clang-tools-extra/clang-doc/assets/namespace-template.mustache
@@ -9,25 +9,7 @@
 <html lang="en-US">
 {{>HeadPartial}}
 <body>
-    <nav class="navbar">
-        <div class="navbar__container">
-            {{#ProjectName}}
-            <div class="navbar__logo">
-                {{ProjectName}}
-            </div>
-            {{/ProjectName}}
-            <div class="navbar__menu">
-                <ul class="navbar__links">
-                    <li class="navbar__item">
-                        <a href="/" class="navbar__link">Namespace</a>
-                    </li>
-                    <li class="navbar__item">
-                        <a href="/" class="navbar__link">Class</a>
-                    </li>
-                </ul>
-            </div>
-        </div>
-    </nav>
+    {{>NavbarPartial}}
     <main>
         <div class="container">
             <div class="sidebar">
diff --git a/clang-tools-extra/clang-doc/assets/navbar-template.mustache b/clang-tools-extra/clang-doc/assets/navbar-template.mustache
@@ -0,0 +1,19 @@
+<nav class="navbar">
+    <div class="navbar__container">
+        {{#ProjectName}}
+        <div class="navbar__logo">
+            {{ProjectName}}
+        </div>
+        {{/ProjectName}}
+        <div class="navbar__menu">
+            <ul class="navbar__links">
+                <li class="navbar__item">
+                    <a href="/" class="navbar__link">Namespace</a>
+                </li>
+                <li class="navbar__item">
+                    <a href="/" class="navbar__link">Class</a>
+                </li>
+            </ul>
+        </div>
+    </div>
+</nav>
diff --git a/clang-tools-extra/clang-doc/support/Utils.cpp b/clang-tools-extra/clang-doc/support/Utils.cpp
@@ -58,6 +58,8 @@ void getHtmlFiles(StringRef AssetsPath, clang::doc::ClangDocContext &CDCtx) {
       appendPathPosix(AssetsPath, "comment-template.mustache");
   SmallString<128> HeadTemplate =
       appendPathPosix(AssetsPath, "head-template.mustache");
+  SmallString<128> NavbarTemplate =
+      appendPathPosix(AssetsPath, "navbar-template.mustache");
 
   CDCtx.MustacheTemplates.insert(
       {"namespace-template", NamespaceTemplate.c_str()});
@@ -67,4 +69,5 @@ void getHtmlFiles(StringRef AssetsPath, clang::doc::ClangDocContext &CDCtx) {
       {"function-template", FunctionTemplate.c_str()});
   CDCtx.MustacheTemplates.insert({"comment-template", CommentTemplate.c_str()});
   CDCtx.MustacheTemplates.insert({"head-template", HeadTemplate.c_str()});
+  CDCtx.MustacheTemplates.insert({"navbar-template", NavbarTemplate.c_str()});
 }
diff --git a/clang-tools-extra/clang-doc/tool/CMakeLists.txt b/clang-tools-extra/clang-doc/tool/CMakeLists.txt
@@ -32,6 +32,7 @@ set(assets
   namespace-template.mustache
   template.mustache
   head-template.mustache
+  navbar-template.mustache
 )
 
 set(asset_dir "${CMAKE_CURRENT_SOURCE_DIR}/../assets")

Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,7 @@ set(assets`
`32`	`32`	`namespace-template.mustache`
`33`	`33`	`template.mustache`
`34`	`34`	`head-template.mustache`
	`35`	`+ navbar-template.mustache`
`35`	`36`	`)`
`36`	`37`
`37`	`38`	`set(asset_dir "${CMAKE_CURRENT_SOURCE_DIR}/../assets")`