Skip to content
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.

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

Add logo, favicon and footer copy #3116

Merged
merged 6 commits into from
Nov 22, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion docs/generation/README.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= ServiceTalk Documentation Website

Repo for ServiceTalk's https://pages.github.com/apple/servicetalk/[documentation website].
Repo for ServiceTalk's https://apple.github.io/servicetalk[documentation website].

The website is built with the https://antora.org[Antora] docsite generator out of https://asciidoctor.org[Asciidoc] docs
maintained in the https://github.com/apple/servicetalk[upstream project].
Expand Down
13 changes: 13 additions & 0 deletions docs/generation/supplemental-ui/css/site-extra.css
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,16 @@ code {
.navigation-container {
width: 13rem;
}

header .navbar .navbar-item a {
display: flex;
}

header .navbar .navbar-logo {
margin-right: 12px;
width: 28px;
}

.footer p {
color: #fff;
}
Binary file added docs/generation/supplemental-ui/favicon.ico
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
5 changes: 4 additions & 1 deletion docs/generation/supplemental-ui/partials/footer-content.hbs
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
<footer class="footer">
<p></p>
<p>Copyright © <span class="footer-year"></span> Apple Inc. All rights reserved.</p>
<script>
document.querySelector('.footer-year').textContent = new Date().getFullYear();
</script>
</footer>
1 change: 1 addition & 0 deletions docs/generation/supplemental-ui/partials/head-icons.hbs
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<link rel="icon" href="{{{siteRootPath}}}/favicon.ico" type="image/x-icon">
5 changes: 4 additions & 1 deletion docs/generation/supplemental-ui/partials/header-content.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,10 @@
<nav class="navbar">
<div class="navbar-brand">
<div class="navbar-item">
<a href="https://github.com/apple/servicetalk">ServiceTalk</a>
<a href="https://github.com/apple/servicetalk">
<img class="navbar-logo" src="{{{siteRootPath}}}/_/img/servicetalk.png" alt="ServiceTalk logo" />
<span>ServiceTalk</span>
</a>
<span class="separator">//</span>
<a href="{{or site.url (or siteRootUrl siteRootPath)}}">Docs</a>
</div>
Expand Down
1 change: 1 addition & 0 deletions docs/generation/supplemental-ui/ui.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,4 @@
static_files:
- _headers
- robots.txt
- favicon.ico
4 changes: 4 additions & 0 deletions servicetalk-concurrent-api/gradle/checkstyle/suppressions.xml
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@
<suppressions>
<suppress checks="LineLength"
files="docs[\\/]modules[\\/]ROOT[\\/]assets[\\/]images[\\/].+\.svg"/>
<suppress checks="LineLength"
files="docs[\\/]generation[\\/]supplemental-ui[\\/].+\.ico"/>
<suppress checks="LineLength"
files="docs[\\/]generation[\\/]supplemental-ui[\\/]img[\\/].+\.src"/>
<!-- mapOnError supports re-throwing a Throwable from onError(Throwable) -->
<suppress checks="IllegalThrowsCheck" files="io[\\/]servicetalk[\\/]concurrent[\\/]api[\\/]ScanWithMapper.java"/>
<suppress checks="IllegalThrowsCheck" files="io[\\/]servicetalk[\\/]concurrent[\\/]api[\\/]ScanMapper.java"/>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -90,7 +90,7 @@ class ServiceTalkCorePlugin implements Plugin<Project> {
source = fileTree(".") {
includes = ["gradle/**", "*.gradle", "*.properties", "scripts/**", "buildSrc/**", "docs/**"]
excludes = ["**/gradle/wrapper/**", "**/build/**", "**/.gradle/**", "**/gradlew*", "**/.cache/**",
"**/*.svg", "**/.out/**", "**/node_modules/**", "**/*.png", "**/*.zip"]
"**/*.svg", "**/.out/**", "**/node_modules/**", "**/*.png", "**/*.ico", "**/*.zip", "**/*.ipr"]
}
}

Expand Down
Loading