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

Upgrade to FontAwesome 6 #1102

Merged
merged 3 commits into from
Aug 15, 2022
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
36 changes: 18 additions & 18 deletions assets/scss/_nav.scss
Original file line number Diff line number Diff line change
Expand Up @@ -121,13 +121,13 @@
font-variant: normal;
text-rendering: auto;
-webkit-font-smoothing: antialiased;
font-family: "Font Awesome 5 Free";
font-weight: 900;
font-family: "Font Awesome 6 Free";
chalin marked this conversation as resolved.
Show resolved Hide resolved
font-weight: 900;
content: "\f0d9";
padding-left: 0.5em;
padding-right: 0.5em;
}
}
}
}

// Foldable sidebar menu
Expand All @@ -136,18 +136,18 @@ nav.foldable-nav {
&#td-section-nav {
position: relative;
}

&#td-section-nav label {
margin-bottom: 0;
width: 100%;
}

.td-sidebar-nav__section, .with-child ul {
list-style: none;
padding: 0;
margin: 0;
}

.ul-1 > li {
padding-left: 1.5em;
}
Expand All @@ -162,8 +162,8 @@ nav.foldable-nav {

input[type=checkbox] { display: none; }

.with-child, .without-child {
position: relative;
.with-child, .without-child {
position: relative;
padding-left: 1.5em;
}

Expand All @@ -173,7 +173,7 @@ nav.foldable-nav {
font-variant: normal;
text-rendering: auto;
-webkit-font-smoothing: antialiased;
font-family: "Font Awesome 5 Free"; font-weight: 900; content: "\f0da";
font-family: "Font Awesome 6 Free"; font-weight: 900; content: "\f0da";
position: absolute;
left: 0.1em;
padding-left: 0.4em;
Expand All @@ -186,30 +186,30 @@ nav.foldable-nav {
}
}

.ul-1 .with-child > input:checked ~ label:before {
.ul-1 .with-child > input:checked ~ label:before {
color: $primary;
transform: rotate(90deg);
transition: transform 0.5s;
transition: transform 0.5s;
}

.with-child ul { margin-top: 0.1em; }
}

}

@media (hover: hover) and (pointer: fine) {

nav.foldable-nav {

.ul-1 .with-child > label:hover:before {
.ul-1 .with-child > label:hover:before {
color: $primary;
transform: rotate(30deg);
transition: transform 0.5s;
transition: transform 0.5s;
}

.ul-1 .with-child > input:checked ~ label:hover:before {
.ul-1 .with-child > input:checked ~ label:hover:before {
color: $primary;
transform: rotate(60deg) !important;
transition: transform 0.5s;
transition: transform 0.5s;
}
}
}
2 changes: 1 addition & 1 deletion assets/scss/_search.scss
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
border-radius: 1rem;
}

font-family: "Font Awesome 5 Free", $font-family-base;
font-family: "Font Awesome 6 Free", $font-family-base;
chalin marked this conversation as resolved.
Show resolved Hide resolved
}

.popover.offline-search-result {
Expand Down
8 changes: 4 additions & 4 deletions assets/scss/_taxonomy.scss
Original file line number Diff line number Diff line change
Expand Up @@ -207,7 +207,7 @@
font-variant: normal;
text-rendering: auto;
-webkit-font-smoothing: antialiased;
font-family: "Font Awesome 5 Free";
font-family: "Font Awesome 6 Free";
// font-weight: 900;
padding-right: 0.5em;
font-size: 2em;
Expand Down Expand Up @@ -298,7 +298,7 @@
font-variant: normal;
text-rendering: auto;
-webkit-font-smoothing: antialiased;
font-family: "Font Awesome 5 Free";
font-family: "Font Awesome 6 Free";
content: "\f02d";
padding-right: 0.5em;
}
Expand All @@ -309,7 +309,7 @@
font-variant: normal;
text-rendering: auto;
-webkit-font-smoothing: antialiased;
font-family: "Font Awesome 5 Free";
font-family: "Font Awesome 6 Free";
content: "\f781";
padding-right: 0.5em;
}
Expand All @@ -325,7 +325,7 @@
font-variant: normal;
text-rendering: auto;
-webkit-font-smoothing: antialiased;
font-family: "Font Awesome 5 Free";
font-family: "Font Awesome 6 Free";
content: "\f122";
padding-right: 0.5em;
}
Expand Down
1 change: 0 additions & 1 deletion assets/scss/support/_functions.scss
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
}



// See https://www.sitepoint.com/using-sass-build-color-palettes/
@function color-diff($a, $b) {
$sat: saturation($a) - saturation($b);
Expand Down
2 changes: 1 addition & 1 deletion layouts/blog/baseof.html
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<main class="col-12 col-md-9 col-xl-8 pl-md-5 pr-md-4" role="main">
{{ with .CurrentSection.OutputFormats.Get "rss" -}}
<a class="btn btn-lg -bg-orange td-rss-button d-none d-lg-block" href="{{ .Permalink | safeURL }}" target="_blank">
RSS <i class="fa fa-rss ml-2 "></i>
RSS <i class="fa-solid fa-rss"></i>
</a>
{{ end -}}
{{ block "main" . }}{{ end }}
Expand Down
14 changes: 7 additions & 7 deletions layouts/partials/page-meta-links.html
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<div class="td-page-meta ml-2 pb-1 pt-2 mb-0">
{{ if $gh_url -}}
{{ warnf "Warning: use of `github_url` is deprecated. For details see https://www.docsy.dev/docs/adding-content/repository-links/#github_url-optional" -}}
<a href="{{ $gh_url }}" target="_blank"><i class="fa fa-edit fa-fw"></i> {{ T "post_edit_this" }}</a>
<a href="{{ $gh_url }}" target="_blank"><i class="fa-solid fa-pen-to-square fa-fw"></i> {{ T "post_edit_this" }}</a>
{{ else if $gh_repo -}}
{{ $gh_repo_path := printf "%s/content/%s" $gh_branch $pathFormatted -}}
{{ if and ($gh_subdir) (.Site.Language.Lang) -}}
Expand Down Expand Up @@ -37,18 +37,18 @@
{{ $newPageQS := querify "value" $newPageStub.Content "filename" "change-me.md" | safeURL -}}
{{ $newPageURL := printf "%s/new/%s?%s" $gh_repo $gh_repo_path $newPageQS -}}

<a href="{{ $viewURL }}" class="td-page-meta--view" target="_blank" rel="noopener"><i class="fa fa-file-alt fa-fw"></i> {{ T "post_view_this" }}</a>
<a href="{{ $editURL }}" class="td-page-meta--edit" target="_blank" rel="noopener"><i class="fa fa-edit fa-fw"></i> {{ T "post_edit_this" }}</a>
<a href="{{ $newPageURL }}" class="td-page-meta--child" target="_blank" rel="noopener"><i class="fa fa-edit fa-fw"></i> {{ T "post_create_child_page" }}</a>
<a href="{{ $issuesURL }}" class="td-page-meta--issue" target="_blank" rel="noopener"><i class="fas fa-tasks fa-fw"></i> {{ T "post_create_issue" }}</a>
<a href="{{ $viewURL }}" class="td-page-meta--view" target="_blank" rel="noopener"><i class="fa-solid fa-file-lines fa-fw"></i> {{ T "post_view_this" }}</a>
<a href="{{ $editURL }}" class="td-page-meta--edit" target="_blank" rel="noopener"><i class="fa-solid fa-pen-to-square fa-fw"></i> {{ T "post_edit_this" }}</a>
<a href="{{ $newPageURL }}" class="td-page-meta--child" target="_blank" rel="noopener"><i class="fa-solid fa-pen-to-square fa-fw"></i> {{ T "post_create_child_page" }}</a>
<a href="{{ $issuesURL }}" class="td-page-meta--issue" target="_blank" rel="noopener"><i class="fa-solid fa-list-check fa-fw"></i> {{ T "post_create_issue" }}</a>
{{ with $gh_project_repo -}}
{{ $project_issueURL := printf "%s/issues/new" . -}}
<a href="{{ $project_issueURL }}" class="td-page-meta--project-issue" target="_blank" rel="noopener"><i class="fas fa-tasks fa-fw"></i> {{ T "post_create_project_issue" }}</a>
<a href="{{ $project_issueURL }}" class="td-page-meta--project-issue" target="_blank" rel="noopener"><i class="fa-solid fa-list-check fa-fw"></i> {{ T "post_create_project_issue" }}</a>
{{ end -}}

{{ end -}}
{{ with .CurrentSection.AlternativeOutputFormats.Get "print" -}}
<a id="print" href="{{ .Permalink | safeURL }}"><i class="fa fa-print fa-fw"></i> {{ T "print_entire_section" }}</a>
<a id="print" href="{{ .Permalink | safeURL }}"><i class="fa-solid fa-print fa-fw"></i> {{ T "print_entire_section" }}</a>
{{ end }}
</div>
{{ end -}}
2 changes: 1 addition & 1 deletion layouts/partials/reading-time.html
Original file line number Diff line number Diff line change
@@ -1 +1 @@
<p class="reading-time"><i class="fa fa-clock" aria-hidden="true"></i>&nbsp;{{ if gt .ReadingTime 1 }} {{ .ReadingTime }} {{ T "post_reading_time" }} {{ else }} {{ T "post_less_than_a_minute_read" }} {{ end }}&nbsp;</p>
<p class="reading-time"><i class="fa-solid fa-clock" aria-hidden="true"></i>&nbsp;{{ if gt .ReadingTime 1 }} {{ .ReadingTime }} {{ T "post_reading_time" }} {{ else }} {{ T "post_less_than_a_minute_read" }} {{ end }}&nbsp;</p>
2 changes: 1 addition & 1 deletion layouts/shortcodes/blocks/link-down.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{{ with .Parent }}
{{ $id := $.Get "id" | default (printf "td-block-%d" ( add .Ordinal 1 )) }}
{{ $color := $.Get "color" | default "blue" }}
<a class="btn btn-link text-{{ $color }}" href="#{{ $id }}" aria-label="{{ T "ui_read_more"}}"><i class="fa fa-chevron-circle-down" style="font-size: 400%"></i></a>
<a class="btn btn-link text-{{ $color }}" href="#{{ $id }}" aria-label="{{ T "ui_read_more"}}"><i class="fa-solid fa-circle-chevron-down" style="font-size: 400%"></i></a>
{{ else }}
{{ errorf "The link-down shortcode is supposed to be nested inside a shortcode"}}
{{ end }}
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"proseWrap": "always"
},
"dependencies": {
"@fortawesome/fontawesome-free": "^5.15.4",
"@fortawesome/fontawesome-free": "^6.1.1",
"bootstrap": "^4.6.1"
},
"devDependencies": {
Expand Down
16 changes: 8 additions & 8 deletions userguide/config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ anchor = "smart"
name = "Example Site"
weight = 40
url = "https://example.docsy.dev"
post = '<sup><i class="pl-1 fas fa-external-link-alt fa-xs" aria-hidden="true"></i></sup>'
post = '<sup><i class="pl-1 fa-solid fa-up-right-from-square fa-xs" aria-hidden="true"></i></sup>'

[services]
[services.googleAnalytics]
Expand Down Expand Up @@ -150,38 +150,38 @@ enable = false
[[params.links.user]]
name ="GitHub Discussions"
url = "https://github.com/google/docsy/discussions"
icon = "fab fa-github"
icon = "fa-brands fa-github"
desc = "Discussion and help from your fellow users"
[[params.links.user]]
name = "User mailing list"
url = "https://groups.google.com/forum/#!forum/docsy-users"
icon = "fa fa-envelope"
icon = "fa-solid fa-envelope"
desc = "Sign up for Docsy announcements"
[[params.links.user]]
name ="Twitter"
url = "https://twitter.com/docsydocs"
icon = "fab fa-twitter"
icon = "fa-brands fa-twitter"
desc = "Follow us on Twitter to get the latest news!"
[[params.links.user]]
name = "Stack Overflow"
url = "https://stackoverflow.com/questions/tagged/docsy"
icon = "fab fa-stack-overflow"
icon = "fa-brands fa-stack-overflow"
desc = "Practical questions and curated answers"
# Developer relevant links. These will show up on right side of footer and in the community page if you have one.
[[params.links.developer]]
name = "GitHub"
url = "https://github.com/google/docsy"
icon = "fab fa-github"
icon = "fa-brands fa-github"
desc = "Development takes place here!"
# [[params.links.developer]]
# name = "Slack"
# url = "https://example.org/slack"
# icon = "fab fa-slack"
# icon = "fa-brands fa-slack"
# desc = "Chat with other project developers"
# [[params.links.developer]]
# name = "Developer mailing list"
# url = "https://example.org/mail"
# icon = "fa fa-envelope"
# icon = "fa-solid fa-envelope"
# desc = "Discuss development issues around the project"

[params.mermaid]
Expand Down
8 changes: 4 additions & 4 deletions userguide/content/en/_index.html
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
{{< blocks/cover title="Welcome to Docsy!" image_anchor="top" height="full" color="orange" >}}
<div class="mx-auto">
<a class="btn btn-lg btn-primary mr-3 mb-4" href="{{< relref "/about" >}}">
Learn More <i class="fas fa-arrow-alt-circle-right ml-2"></i>
Learn More <i class="fa-solid fa-circle-right ml-2"></i>
</a>
<a class="btn btn-lg btn-secondary mr-3 mb-4" href="https://github.com/google/docsy">
Download <i class="fab fa-github ml-2 "></i>
Download <i class="fa-brands fa-github ml-2 "></i>
</a>
<p class="lead mt-5">A Hugo theme for creating great technical documentation sites</p>
{{< blocks/link-down color="info" >}}
Expand All @@ -32,12 +32,12 @@
{{% /blocks/feature %}}


{{% blocks/feature icon="fab fa-github" title="Contributions welcome!" url="https://github.com/google/docsy" %}}
{{% blocks/feature icon="fa-brands fa-github" title="Contributions welcome!" url="https://github.com/google/docsy" %}}
We do a [Pull Request](https://github.com/google/docsy/pulls) contributions workflow on **GitHub**. New users are always welcome!
{{% /blocks/feature %}}


{{% blocks/feature icon="fab fa-twitter" title="Follow us on Twitter!" url="https://twitter.com/docsydocs" %}}
{{% blocks/feature icon="fa-brands fa-twitter" title="Follow us on Twitter!" url="https://twitter.com/docsydocs" %}}
Find out about new features and how our users are using Docsy.
{{% /blocks/feature %}}

Expand Down
8 changes: 4 additions & 4 deletions userguide/content/en/docs/adding-content/content.md
Original file line number Diff line number Diff line change
Expand Up @@ -561,27 +561,27 @@ params:
{
"name": "Twitter",
"url": "https://example.org/twitter",
"icon": "fab fa-twitter",
"icon": "fa-brands fa-twitter",
"desc": "Follow us on Twitter to get the latest news!"
},
{
"name": "Stack Overflow",
"url": "https://example.org/stack",
"icon": "fab fa-stack-overflow",
"icon": "fa-brands fa-stack-overflow",
"desc": "Practical questions and curated answers"
}
],
"developer": [
{
"name": "GitHub",
"url": "https://github.com/google/docsy",
"icon": "fab fa-github",
"icon": "fa-brands fa-github",
"desc": "Development takes place here!"
},
{
"name": "Slack",
"url": "https://example.org/slack",
"icon": "fab fa-slack",
"icon": "fa-brands fa-slack",
"desc": "Chat with other project developers"
},
{
Expand Down
14 changes: 7 additions & 7 deletions userguide/content/en/docs/adding-content/navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ linkTitle = "Documentation"

[menu.main]
weight = 20
pre = "<i class='fas fa-book'></i>"
pre = "<i class='fa-solid fa-book'></i>"
+++
{{< /tab >}}
{{< tab header="yaml" lang="yaml" >}}
Expand All @@ -31,7 +31,7 @@ linkTitle: "Documentation"
menu:
main:
weight: 20
pre: <i class='fas fa-book'></i>
pre: <i class='fa-solid fa-book'></i>
---
{{< /tab >}}
{{< tab header="json" lang="json" >}}
Expand All @@ -41,7 +41,7 @@ menu:
"menu": {
"main": {
"weight": 20,
"pre": "<i class='fas fa-book'></i>"
"pre": "<i class='fa-solid fa-book'></i>"
}
}
}
Expand Down Expand Up @@ -93,7 +93,7 @@ As described in the [Hugo docs](https://gohugo.io/content-management/menus/#add-
name = "GitHub"
weight = 50
url = "https://github.com/google/docsy/"
pre = "<i class='fab fa-github'></i>"
pre = "<i class="fa-brands fa-github"></i>"
post = "<span class='alert'>New!</span>"
{{< /tab >}}
{{< tab header="config.yaml" lang="yaml" >}}
Expand All @@ -102,7 +102,7 @@ menu:
- name: GitHub
weight: 50
url: 'https://github.com/google/docsy/'
pre: <i class='fab fa-github'></i>
pre: <i class="fa-brands fa-github"></i>
post: <span class='alert'>New!</span>
{{< /tab >}}
{{< tab header="config.json" lang="json" >}}
Expand All @@ -113,7 +113,7 @@ menu:
"name": "GitHub",
"weight": 50,
"url": "https://github.com/google/docsy/",
"pre": "<i class='fab fa-github'></i>",
"pre": "<i class="fa-brands fa-github"></i>",
"post": "<span class='alert'>New!</span>"
}
]
Expand Down Expand Up @@ -227,7 +227,7 @@ On large sites (default: > 2000 pages) the section menu is not generated for eac

### Add icons to the section menu

You can add icons to the section menu in the sidebar by setting the `icon` parameter in the page front matter (e.g. `icon: fas fa-tools`).
You can add icons to the section menu in the sidebar by setting the `icon` parameter in the page front matter (e.g. `icon: fa-solid fa-screwdriver-wrench`).

You can find a complete list of icons to use in the [FontAwesome documentation](https://fontawesome.com/icons?d=gallery&p=2). Docsy includes the free FontAwesome icons by default.

Expand Down
Loading