diff --git a/CHANGELOG.md b/CHANGELOG.md index ef9a2d965..0bc5fd14a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 @@ -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 diff --git a/assets/scss/main.scss b/assets/scss/main.scss index b8c487d00..2152c7383 100644 --- a/assets/scss/main.scss +++ b/assets/scss/main.scss @@ -84,6 +84,10 @@ &__all_rights_reserved { padding-left: map-get($spacers, 1); } + + &__all_rights_reserved { + display: none; + } } // Adjust anchors vs the fixed menu. diff --git a/layouts/partials/footer/center.html b/layouts/partials/footer/center.html index 46335abe5..88a5f8e83 100644 --- a/layouts/partials/footer/center.html +++ b/layouts/partials/footer/center.html @@ -4,7 +4,11 @@ {{ T "footer_privacy_policy" }} {{- 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" -}} {{- end -}} diff --git a/userguide/assets/scss/_styles_project.scss b/userguide/assets/scss/_styles_project.scss index 34d934428..e69de29bb 100644 --- a/userguide/assets/scss/_styles_project.scss +++ b/userguide/assets/scss/_styles_project.scss @@ -1,5 +0,0 @@ -.td-footer { - &__all_rights_reserved { - display: none; - } -} diff --git a/userguide/hugo.yaml b/userguide/hugo.yaml index 5d0a26567..26eb4694c 100644 --- a/userguide/hugo.yaml +++ b/userguide/hugo.yaml @@ -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 @@ -74,7 +74,6 @@ params: search: # algolia: ui: - footer_about_disable: true sidebar_cache_limit: 10 sidebar_menu_compact: true sidebar_menu_foldable: false