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

Footer streamlining: hide About-link and All-rights text by default #1849

Merged
merged 1 commit into from
Feb 8, 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
34 changes: 27 additions & 7 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,28 +48,46 @@ For the full list of changes, see the [0.9.0] release notes.
`render-heading.html` [hook], in favor of client-side rendering via
`assets/js/anchor.js` — which has been dropped ([#1460]).

**Footer changes**: refactoring, for easier customization, and simplification.
For details concerning all footer changes, see [#1818].

- **Footer layout** has been factored into parts: _left_, _right_, and _center_,
with _copyright_ a subpart of center. Each part has its own style tag, for
example: `td-footer__left`. Note that the style `td-footer__copyright-etc` has
been renamed to `td-footer__center`. For details concerning all footer
changes, see [#1818].
been renamed to `td-footer__center`.

**Other changes**:
- **Footer copyright**, supports date-range, and site copyright fallback.

- **Footer copyright**:
- Hugo config option `params.copyright`, previously a string, can now also be
a map with the following optional fields: `authors`, `from_year`, `to_year`.
When unset, `to_year` defaults to the year that the site built. The default
`authors` is "Site Authors" and this field is rendered as markdown.
- If `params.copyright` is unset, then the [site `copyright`] option will be
used and rendered as markdown, "as is" — with no year is added.

- **Footer simplification**
- The About-page footer link is now hidden by default. To enable this link,
set `.params.ui.footer_about_enable` to true in your project's configuration
file. Parameter `.params.ui.footer_about_disable` is deprecated.
- The All-rights-reserved text is hidden by default. To make it visible, add
the following to your `_styles_project.scss` [project style file], or delete
the `"footer_all_rights_reserved"` [language parameter] for all your site's
languages:
```scss
.td-footer__all_rights_reserved {
display: inline;
}
```

**Other changes**:

- **[blocks/feature] shortcode** no longer adds ellipsis (`...`) after the
read-more text. If you would like to recover the ellipsis, then add them to
the `"ui_read_more"` [language parameter] for your site's languages ([#1820]).
- The latest release of **[Mermaid] resources** are fetched at build time
([#1410]).
- Docsy follows recommended accessibility practice: page-body **links are
underlined**. For details, see [#1814] and [#1815].
- **[blocks/feature] shortcode** no longer adds ellipsis (`...`) after the
read-more text. If you would like to recover the ellipsis, then add them to
the "ui_read_more" [language parameter] for your site's languages ([#1820]).

[0.9.0]: https://github.com/google/docsy/releases/latest?FIXME=v0.9.0
[#1410]: https://github.com/google/docsy/pull/1410
Expand All @@ -90,6 +108,8 @@ For the full list of changes, see the [0.9.0] release notes.
[multi-language]: https://www.docsy.dev/docs/language/
[path_base_for_github_subdir]:
https://www.docsy.dev/docs/adding-content/repository-links/#path_base_for_github_subdir-optional
[project style file]:
https://www.docsy.dev/docs/adding-content/lookandfeel/#project-style-files
[hook]: https://gohugo.io/templates/render-hooks/
[language parameter]:
https://www.docsy.dev/docs/language/#internationalization-bundles
Expand Down
4 changes: 4 additions & 0 deletions assets/scss/main.scss
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,10 @@
&__all_rights_reserved {
padding-left: map-get($spacers, 1);
}

&__all_rights_reserved {
display: none;
}
}

// Adjust anchors vs the fixed menu.
Expand Down
6 changes: 5 additions & 1 deletion layouts/partials/footer/center.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,11 @@
<span class="ms-2"><a href="{{ . }}" target="_blank" rel="noopener">{{ T "footer_privacy_policy" }}</a></span>
{{- end -}}

{{ if not .Site.Params.ui.footer_about_disable -}}
{{ if ne .Site.Params.ui.footer_about_disable nil -}}
{{ warnf "Config parameter '.params.ui.footer_about_disable' is DEPRECATED, use '.params.ui.footer_about_enable' instead." -}}
{{ end }}

{{ if or .Site.Params.ui.footer_about_enable (eq .Site.Params.ui.footer_about_disable false) -}}
{{ with .Site.GetPage "about" -}}
<p class="td-footer__about mt-2"><a href="{{ .RelPermalink }}">{{ .Title }}</a></p>
{{- end -}}
Expand Down
5 changes: 0 additions & 5 deletions userguide/assets/scss/_styles_project.scss
Original file line number Diff line number Diff line change
@@ -1,5 +0,0 @@
.td-footer {
&__all_rights_reserved {
display: none;
}
}
3 changes: 1 addition & 2 deletions userguide/hugo.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ params:
copyright:
authors: >-
Docsy Authors |
[CC BY 4.0](https://creativecommons.org/licenses/by/4.0) |
[CC BY 4.0](https://creativecommons.org/licenses/by/4.0) |
from_year: 2018
privacy_policy: https://policies.google.com/privacy
version_menu: Releases
Expand All @@ -74,7 +74,6 @@ params:
search:
# algolia:
ui:
footer_about_disable: true
sidebar_cache_limit: 10
sidebar_menu_compact: true
sidebar_menu_foldable: false
Expand Down