Skip to content

Commit

Permalink
Update repository-links.md: fix prose to mention config param
Browse files Browse the repository at this point in the history
  • Loading branch information
chalin committed Feb 13, 2024
1 parent 262e748 commit f742b5c
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 8 deletions.
14 changes: 8 additions & 6 deletions userguide/content/en/blog/2024/0.9.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ easier customization, are planned for the next [major release][#1812] ([#1852]).
In support of easier footer customization, the footer layout has been factored
into parts: _left_, _right_, and _center_ ([#1500]), with _copyright_ as a
subpart of center ([#1817]). Each part has its own class, such as
`td-footer__left`, for easy style customization. Note that the style
`td-footer__left`, for easy style customization. Note that the class
`td-footer__copyright-etc` has been renamed to `td-footer__center`.

### Footer copyright date-range and more {#footer-copyright}
Expand All @@ -52,8 +52,8 @@ fallback:
`to_year`. When unset, `to_year` defaults to the year that the site built. The
default `authors` is "<Site.Title> 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" &mdash; with no year is added.
- If `params.copyright` is unset, then the [site `copyright`] configuration
option will be used and rendered as markdown "as is".

[site `copyright`]: https://gohugo.io/methods/site/copyright/

Expand All @@ -65,7 +65,7 @@ fallback:
- 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:
languages.
```scss
.td-footer__all_rights_reserved {
display: inline;
Expand Down Expand Up @@ -118,7 +118,7 @@ Guide section [Last-modified page metadata].
Docsy has switched to build-time generation of heading self links using Hugo's
`render-heading.html` [hook], replacing client-side rendering via
`assets/js/anchor.js` (dropped in [#1460]). Projects must now explicitly enable
the feature.
the feature. For details, see [Heading self links].

Formerly an embedded SVG, the default self-link text is now CSS-defined to be
`#`, a common choice for websites. Projects can customize the appearance of the
Expand All @@ -128,6 +128,8 @@ now:
- Always visible on mobile and touch devices
- Otherwise the link is invisible until the user hovers over the heading

[Heading self links]: /docs/adding-content/navigation/#heading-self-links

### Accessibility: Links are underlined

Docsy now follows recommended **accessibility practice**: page-body **links are
Expand All @@ -145,7 +147,7 @@ For the complete list of changes in this release, see the [CHANGELOG entry for
0.9.0][0.9.0] and the issue
[Release 0.9.0 preparation #1759](https://github.com/google/docsy/issues/1759)

What is on the horizon for Docsy improvements? For work items _tentatively_
Which Docsy improvements are on the horizon? For work items _tentatively_
planed for the next release, see
[Release 0.10.0 preparation #1812](https://github.com/google/docsy/issues/1812).

Expand Down
6 changes: 4 additions & 2 deletions userguide/content/en/docs/adding-content/repository-links.md
Original file line number Diff line number Diff line change
Expand Up @@ -360,8 +360,10 @@ Class names using the `--KIND` suffix were deprecated as of [v0.9.0].
## Last-modified page metadata

To have page-source metadata displayed at the bottom of documentation pages and
blog posts, set the following configuration parameter to `true`. A
last-modified page note looks something like this:
blog posts, set the `GitInfo` configuration parameter to `true`, and ensure that
`params.github_repo` is defined.

A last-modified page note looks something like this:

> <div class="td-page-meta__lastmod"
> style="margin-top: 0 !important; display: block !important;">
Expand Down

0 comments on commit f742b5c

Please sign in to comment.