Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
evelez7 merged 3 commits into from
Dec 11, 2025
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8a92239
[clang-doc] Create a partial for HTML <head> sections
evelez7 Nov 15, 2025
1d32cb2
[clang-doc] Create a partial for the navbar
evelez7 Dec 4, 2025
d90db85
Merge branch 'main' into users/evelez7/clang-doc-navbar-partial
evelez7 Dec 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion clang-tools-extra/clang-doc/HTMLGenerator.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
20 changes: 1 addition & 19 deletions clang-tools-extra/clang-doc/assets/class-template.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down
20 changes: 1 addition & 19 deletions clang-tools-extra/clang-doc/assets/namespace-template.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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">
Expand Down
19 changes: 19 additions & 0 deletions clang-tools-extra/clang-doc/assets/navbar-template.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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>
3 changes: 3 additions & 0 deletions clang-tools-extra/clang-doc/support/Utils.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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()});
Expand All @@ -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()});
}
1 change: 1 addition & 0 deletions clang-tools-extra/clang-doc/tool/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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")
Expand Down