Skip to content

Commit

Permalink
Squashed commit of the following:
Browse files Browse the repository at this point in the history
commit 77da7e4
Author: Patrice Chalin <[email protected]>
Date:   Thu Jan 30 06:08:47 2025 -0500

    Fix language-drop style when in left nav (google#2183)

commit a854cb3
Author: Patrice Chalin <[email protected]>
Date:   Thu Jan 23 20:21:54 2025 -0500

    Update Hugo to 0.142.0, and more (google#2182)

commit 7b3eaa4
Author: Andreas Deininger <[email protected]>
Date:   Tue Jan 21 21:28:01 2025 +0100

    Remove docsy's custom shortcode 'figure' (google#2175)

commit 258d3e5
Author: Patrice Chalin <[email protected]>
Date:   Tue Jan 21 14:48:14 2025 -0500

    Drop style attribute using undef CSS var (google#2180)

commit ef59ee7
Author: Patrice Chalin <[email protected]>
Date:   Mon Jan 20 17:47:51 2025 -0500

    [CI] Upgrade NPM packages (google#2179)

commit 9c41490
Author: Andreas Deininger <[email protected]>
Date:   Mon Jan 20 23:29:41 2025 +0100

    Fix error when building user guide with latest hugo version 0.141.0 (google#2177)

commit e6d9477
Author: Patrice Chalin <[email protected]>
Date:   Fri Jan 10 11:30:19 2025 -0500

    Breadcrumb for blog pages, and per-page/section config (google#2161)

commit 9fbb3a6
Author: Andreas Deininger <[email protected]>
Date:   Thu Jan 9 22:10:40 2025 +0100

    Bump KaTeX to latest version (google#2168)

commit a9ea2b7
Author: Peter Dave Hello <[email protected]>
Date:   Fri Jan 10 00:51:45 2025 +0800

    Update and improve zh-TW Traditional Chinese locale (google#2158)

    Co-authored-by: ChengHao Yang <[email protected]>

commit 1b3fc5a
Author: Patrice Chalin <[email protected]>
Date:   Thu Jan 9 08:47:53 2025 -0500

    Userguide config cleanup, drop pygments config (google#2166)

commit 88ec5ae
Author: Patrice Chalin <[email protected]>
Date:   Thu Jan 9 08:40:44 2025 -0500

    Render-heading: process class attributes (google#2165)

commit dd5e69b
Author: Patrice Chalin <[email protected]>
Date:   Wed Jan 8 12:46:18 2025 -0500

    Hide index-page single breadcrumb (google#2160)

commit 30a6c34
Author: Patrice Chalin <[email protected]>
Date:   Wed Jan 8 12:18:17 2025 -0500

    Blog list layout whitespace cleanup (google#2159)

commit 3aa3dc7
Author: Patrice Chalin <[email protected]>
Date:   Wed Jan 8 11:49:09 2025 -0500

    Blog list layout: display the page title and content (google#2157)

commit 6c22754
Author: Patrice Chalin <[email protected]>
Date:   Tue Jan 7 17:04:11 2025 -0500

    Blog list layout refactoring (google#2155)

commit 95a08e1
Author: Patrice Chalin <[email protected]>
Date:   Tue Jan 7 12:49:26 2025 -0500

    [CI] Upgrade NPM pkgs, Hugo to 0.140.2 (google#2154)

commit 2f361b2
Author: rinsuki <[email protected]>
Date:   Sun Jan 5 02:09:10 2025 +0900

    i18n: Add feedback_* to i18n/ja.toml (google#2149)

commit fa81a86
Author: Andreas Deininger <[email protected]>
Date:   Fri Jan 3 22:59:17 2025 +0100

    Bump dependency Font-Awesome to latest version 6.7.2 (google#2151)

commit 67f6b6a
Author: Patrice Chalin <[email protected]>
Date:   Thu Dec 12 13:27:01 2024 -0500

    Blog 2024 review: Add link to LFX mentorships (google#2147)

commit f3e6ca9
Author: Patrice Chalin <[email protected]>
Date:   Thu Dec 12 12:41:08 2024 -0500

    Blog 2024 year in review (google#2145)

commit 99c2842
Author: Patrice Chalin <[email protected]>
Date:   Thu Dec 12 10:05:14 2024 -0500

    [CI] Upgrade NPM pkgs, Hugo to 0.139.4 (google#2143)

commit dd72a27
Author: Patrice Chalin <[email protected]>
Date:   Sat Nov 23 06:34:07 2024 -0500

    [CI] Patch search page HTML until Hugo is fixed, FA upgrade (google#2135)

commit fed2d28
Author: Patrice Chalin <[email protected]>
Date:   Wed Nov 20 06:09:53 2024 -0500

    Upgrade Hugo and FontAwesome (google#2129)

commit 97dadaa
Author: Patrice Chalin <[email protected]>
Date:   Tue Nov 19 18:48:09 2024 -0500

    [CI] Handle creation of empty Hugo-modules for deps (google#2128)

commit 2a6ecfc
Author: Patrice Chalin <[email protected]>
Date:   Tue Nov 19 17:33:23 2024 -0500

    Update CHANGELOG.md: fix copy-paste error (google#2127)

commit 706e23c
Author: Shihyu <[email protected]>
Date:   Sat Nov 16 23:29:23 2024 +0800

    Fix typo in deployment documentation (google#2123)

commit aedef51
Author: Patrice Chalin <[email protected]>
Date:   Fri Nov 15 11:47:52 2024 -0500

    Upgrade Hugo and merge optional deps into dev (google#2125)

commit d1e6470
Author: Patrice Chalin <[email protected]>
Date:   Fri Nov 15 11:29:18 2024 -0500

    [CI] Restore format check as a part of `npm test` (google#2124)

commit 6e42d49
Author: Patrice Chalin <[email protected]>
Date:   Fri Nov 15 11:19:51 2024 -0500

    External link checking + project pages (google#2120)
  • Loading branch information
rbfmarshallc committed Jan 30, 2025
1 parent 9693228 commit 823b9bc
Show file tree
Hide file tree
Showing 40 changed files with 1,779 additions and 224 deletions.
19 changes: 0 additions & 19 deletions .markdown-link-check.json

This file was deleted.

58 changes: 42 additions & 16 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,17 +20,36 @@ Useful links:

## 0.11.1 or 0.12.0

> ### UNRELEASED: this planned version is still under development
> **UNRELEASED: this planned version is still under development**
For the full list of changes, see the [0.x.y] release notes.

**Breaking changes**:
**Potential breaking change**:

- Removes shortcode `figure`, hugo's built-in shortcode `figure` can/will be
used instead

**New**:

- **[Breadcrumb navigation]** support has been enhanced and adjusted:
- You can now disable breadcrumbs for an entire project, or individual pages
or sections by setting `ui.breadcrumb_disable` to true. For details, see
[Breadcrumb navigation].
- **Blog** pages now also have breadcrumbs by default ([#1788]).
- Index-page single-element breadcrumb lists are hidden by default ([#2160]).

**Other changes**:

- **Blog** section index page content and title used to be ignored, they are now
displayed ([#1787]). To recover the old behavior use the following style
override: `.td-section.td-blog .td-content { display: none; }`.

[0.x.y]: https://github.com/google/docsy/releases/latest?FIXME=v0.X.Y
[#1787]: https://github.com/google/docsy/issues/1787
[#1788]: https://github.com/google/docsy/issues/1788
[#2160]: https://github.com/google/docsy/pull/2160
[Breadcrumb navigation]:
https://www.docsy.dev/docs/adding-content/navigation/#breadcrumb-navigation

## 0.11.0

Expand Down Expand Up @@ -106,8 +125,8 @@ this release are listed next.
[path_base_for_github_subdir]. Projects will need to adjust the value of
[path_base_for_github_subdir] to be relative to the file's physical location.

- Class names to disable [repository links] were misnamed with a suffix of the form
`--KIND`. The new suffix is `__KIND`. For details, see [Disabling links].
- Class names to disable [repository links] were misnamed with a suffix of the
form `--KIND`. The new suffix is `__KIND`. For details, see [Disabling links].

- **Heading self-link** support has been reimplemented and projects must now
explicitly enable the feature. For details, see [Heading self links].
Expand Down Expand Up @@ -157,9 +176,9 @@ For the full list of changes, see the [0.8.0] release notes.

- Docsy is packaged as a **single Hugo module** ([#1120]). For details, see [Use
Docsy as a Hugo Module].
- **Important**: non-Hugo-module projects should be aware of the [Docsy
NPM install side-effect]. Also, for guidance on Hugo-reported "failed to load modules"
error, see [Docsy as an NPM package].
- **Important**: non-Hugo-module projects should be aware of the [Docsy NPM
install side-effect]. Also, for guidance on Hugo-reported "failed to load
modules" error, see [Docsy as an NPM package].
- **Page feedback**, or [User feedback]:
- In support of projects configuring analytics outside of Docsy, feedback
functionality is enabled regardless of whether
Expand All @@ -179,7 +198,7 @@ For the full list of changes, see the [0.8.0] release notes.
[#1727]: https://github.com/google/docsy/pull/1727
[0.8.0]: https://github.com/google/docsy/releases/v0.8.0
[Docsy as an NPM package]:
http://localhost:1313/docs/get-started/other-options/#option-3-docsy-as-an-npm-package
https://docsy.dev/docs/get-started/other-options/#option-3-docsy-as-an-npm-package
[Docsy NPM install side-effect]:
https://docsy.dev/docs/get-started/other-options/#docsy-npm-install-side-effect
[Use Docsy as a Hugo Module]:
Expand Down Expand Up @@ -255,7 +274,8 @@ For the full list of changes, see the [0.7.0] release notes.
- **Shortcodes**:
- Now using Hugo's native support for processing HTML & markdown, not file
extension testing. ([#906])
- Dropped support for pre-Hugo-0.54.x behavior of `{{% %}}`. ([#939])
- Dropped support for pre-Hugo-0.54.x behavior of [shortcodes with markdown],
`{{%/*...*/%}}`. ([#939])
- `blocks/section`: **default** and accepted values of the `type` argument
have changed! For details, see [blocks/section] ([#1472]).
- **Card shortcodes** ([#1376])]:
Expand All @@ -268,6 +288,8 @@ For the full list of changes, see the [0.7.0] release notes.

[chroma-docsy]:
https://www.docsy.dev/docs/adding-content/lookandfeel/#code-highlighting-with-chroma
[shortcodes with markdown]:
https://gohugo.io/content-management/shortcodes/#shortcodes-with-markdown

- **Detection of draw.io diagrams** is now **disabled** by default [#1185]

Expand Down Expand Up @@ -339,12 +361,13 @@ CHANGES** are documented below.
as text.
- **Display logo by default**. Most projects show their logo in the navbar. In
support of this majority, Docsy now displays a logo by default. For details on
how to hide the logo (or your brand name), see [Styling your project logo and name].
how to hide the logo (or your brand name), see [Styling your project logo and
name].
- **Upgraded Bootstrap** to v4.6.2 from v4.6.1, resulting in some style changes
(such as an adjustment in the size of `small`). For details, see [v4.6.2
release notes].
- **[Upgraded FontAwesome]** to v6 from v5. While many icons were renamed, the v5
names still work. For details about icon renames and more, see [What's
- **[Upgraded FontAwesome]** to v6 from v5. While many icons were renamed, the
v5 names still work. For details about icon renames and more, see [What's
changed].
- **Search-box**: the HTML structure and class names have changed, due to the
Font Awesome upgrade, for both online and offline search. This may affect your
Expand Down Expand Up @@ -452,9 +475,10 @@ For the full list of changes, see the [0.2.0] release notes.
**New**:
- Add official Docsy support for [Hugo modules]. Many thanks to the dedicated and
patient efforts of [@deining], who researched, experimented, and implemented this
feature. Thanks to [@deining] and [@LisaFC] for the doc updates.
- Add official Docsy support for [Hugo modules]. Many thanks to the dedicated
and patient efforts of [@deining], who researched, experimented, and
implemented this feature. Thanks to [@deining] and [@LisaFC] for the doc
updates.
For details, see
[Migrate to Hugo Modules](https://www.docsy.dev/docs/updating/convert-site-to-module/).
Expand All @@ -466,9 +490,10 @@ For the full list of changes, see the [0.2.0] release notes.
<!-- ENTRY TEMPLATE ------------------------------------------------------
```
## 0.X.Y
> ### UNRELEASED: this planned version is still under development
> **UNRELEASED: this planned version is still under development**
For the full list of changes, see the [0.x.y] release notes.
Expand All @@ -481,5 +506,6 @@ For the full list of changes, see the [0.x.y] release notes.
**Other changes**:
[0.x.y]: https://github.com/google/docsy/releases/latest?FIXME=v0.X.Y
```
---------------------------------------------------------------------------->
17 changes: 10 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,9 @@ repo.
the end of the file. (Note that change details are autogenerated by GitHub
in a later step.)
3. **Update Docsy version** to v0.X.Y for:
- `version` key in [package.json](package.json)
- `version` key in [userguide/hugo.yaml][]
4. Run `npm run ci:prepare` to ensure that vendor assets and [go.mod](go.mod)
- `version` key in [package.json]
- `version` key in [userguide/hugo.yaml]
4. Run `npm run ci:prepare` to ensure that vendor assets and [go.mod]
dependencies are up-to-date.
5. **Submit a PR with your changes**, using a title like "Release v0.X.Y
preparation".
Expand Down Expand Up @@ -117,8 +117,8 @@ Assuming that Docsy release v0.X.Y has been successfully deployed and use by at
least one downstream project, then perform the following actions before any
further changes are merged into the default branch:

1. Set `version` in [package.json](package.json) to the next planned (or the
next dot) release with a dev suffix, such as `v0.X.Z-dev-unreleased`.
1. Set `version` in [package.json] to the next planned (or the next dot) release
with a dev suffix, such as `v0.X.Z-dev-unreleased`.
2. In the [CHANGELOG]:
- **Create a new entry** for the next release by copying the ENTRY TEMPLATE
at the end of the file.
Expand All @@ -128,8 +128,11 @@ further changes are merged into the default branch:
version to next unreleased dev version".
4. **Get PR approved and merged**.

[CHANGELOG]: CHANGELOG.md
[CHANGELOG]: https://github.com/google/docsy/blob/main/CHANGELOG.md
[contribution guidelines]: https://www.docsy.dev/docs/contribution-guidelines/
[docsy-example]: https://github.com/google/docsy-example
[Draft a new release]: https://github.com/google/docsy/releases/new
[userguide/hugo.yaml]: userguide/hugo.yaml
[go.mod]: https://github.com/google/docsy/blob/main/go.mod
[package.json]: https://github.com/google/docsy/blob/main/package.json
[userguide/hugo.yaml]:
https://github.com/google/docsy/blob/main/userguide/hugo.yaml
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
[![Project contributors](https://img.shields.io/github/contributors/google/docsy)](https://github.com/google/docsy/graphs/contributors)
[![Project license](https://img.shields.io/github/license/google/docsy)](https://github.com/google/docsy/blob/main/LICENSE)

## 🚧 WARNING 🚧 : `main` is under development and potentially unstable! Use official Docsy [releases].
> **🚧 WARNING 🚧 : `main` is under development and potentially unstable! Use
> official Docsy [releases].**
Docsy is a [Hugo](https://gohugo.io) theme for technical documentation sets,
providing simple navigation, site structure, and more.
Expand Down Expand Up @@ -95,8 +96,8 @@ requests, see [CONTRIBUTING.md]. Thank you to all past, present, and future

## License

This project is licensed under the Apache License 2.0 - see the
[LICENSE.md](https://github.com/google/docsy/blob/main/LICENSE) file for details
This project is licensed under the Apache License 2.0 - see
[LICENSE](https://github.com/google/docsy/blob/main/LICENSE) for details

[code of conduct]:
https://github.com/google/.github/blob/master/CODE_OF_CONDUCT.md
Expand Down
6 changes: 5 additions & 1 deletion assets/scss/_breadcrumb.scss
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,11 @@

.td-breadcrumbs {
@media print {
display: none !important;
display: none;
}

&__single {
display: none;
}

.breadcrumb {
Expand Down
15 changes: 5 additions & 10 deletions assets/scss/_sidebar-tree.scss
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,8 @@
list-style: none;
}

&.ul-0, ul {
&.ul-0,
ul {
padding: 0;
margin: 0;
}
Expand Down Expand Up @@ -87,14 +88,9 @@
}
}

.dropdown {
a {
color: var(--bs-tertiary-color);
}

.nav-link {
padding: 0 0 1rem;
}
.dropdown .nav-link {
padding-left: 1.5rem;
margin-bottom: 0.5rem;
}

& > .td-sidebar-nav__section {
Expand Down Expand Up @@ -123,7 +119,6 @@

@include media-breakpoint-up(md) {
padding-top: 4rem;
background-color: var(--bs-body-tertiary-bg);
padding-right: 1rem;
border-right: 1px solid var(--bs-border-color);
}
Expand Down
2 changes: 1 addition & 1 deletion assets/scss/shortcodes/tabbed-pane.scss
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
border: none;
max-width: 100%;
}
margin-top: 0rem;
margin-top: 0;
margin-bottom: 1.5rem;
border-left: $nav-tabs-border-width solid $nav-tabs-border-color;
border-right: $nav-tabs-border-width solid $nav-tabs-border-color;
Expand Down
2 changes: 2 additions & 0 deletions assets/scss/td/chroma/_dark.scss
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
/* Chroma style: onedark */
/* Generated using: hugo gen chromastyles --style=onedark */

/* Background */ .bg { color:#abb2bf;background-color:#282c34; }
/* PreWrapper */ .chroma { color:#abb2bf;background-color:#282c34; }
/* Other */ .chroma .x { }
Expand Down
2 changes: 2 additions & 0 deletions assets/scss/td/chroma/_light.scss
Original file line number Diff line number Diff line change
@@ -1,4 +1,6 @@
/* Chroma style: tango */
/* Generated using: hugo gen chromastyles --style=tango */

/* Background */ .bg { background-color:#f8f8f8; }
/* PreWrapper */ .chroma { background-color:#f8f8f8; }
/* Other */ .chroma .x { color:#000 }
Expand Down
2 changes: 1 addition & 1 deletion go.mod
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,6 @@ go 1.12
// AUTO-GENERATED using `npm run get:hugo-modules`

require (
github.com/FortAwesome/Font-Awesome v0.0.0-20240716171331-37eff7fa00de // indirect
github.com/FortAwesome/Font-Awesome v0.0.0-20241216213156-af620534bfc3 // indirect
github.com/twbs/bootstrap v5.3.3+incompatible // indirect
)
4 changes: 2 additions & 2 deletions go.sum
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
github.com/FortAwesome/Font-Awesome v0.0.0-20240716171331-37eff7fa00de h1:JvHOfdSqvArF+7cffH9oWU8oLhn6YFYI60Pms8M/6tI=
github.com/FortAwesome/Font-Awesome v0.0.0-20240716171331-37eff7fa00de/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
github.com/FortAwesome/Font-Awesome v0.0.0-20241216213156-af620534bfc3 h1:/iluJkJiyTAdnqrw3Yi9rH2HNHhrrtCmj8VJe7I6o3w=
github.com/FortAwesome/Font-Awesome v0.0.0-20241216213156-af620534bfc3/go.mod h1:IUgezN/MFpCDIlFezw3L8j83oeiIuYoj28Miwr/KUYo=
github.com/twbs/bootstrap v5.3.3+incompatible h1:goFoqinzdHfkeegpFP7pvhbd0g+A3O2hbU3XCjuNrEQ=
github.com/twbs/bootstrap v5.3.3+incompatible/go.mod h1:fZTSrkpSf0/HkL0IIJzvVspTt1r9zuf7XlZau8kpcY0=
10 changes: 10 additions & 0 deletions i18n/ja.toml
Original file line number Diff line number Diff line change
Expand Up @@ -77,3 +77,13 @@ other = "If you want to get more involved by contributing to {{ .Site.Title }},
other = "You can find out how to contribute to {{ .Site.Title }} in our"
[community_guideline]
other = "Contribution Guidelines"

# Feedback
[feedback_title]
other = "フィードバック"
[feedback_question]
other = "このページは役に立ちましたか?"
[feedback_positive]
other = "役に立った"
[feedback_negative]
other = "役に立たなかった"
40 changes: 25 additions & 15 deletions i18n/zh-tw.toml
Original file line number Diff line number Diff line change
Expand Up @@ -32,50 +32,60 @@ other = "隱私政策"
[post_byline_by]
other = "作者:"
[post_created]
other = "創建"
other = "建立"
[post_last_mod]
other = "最後修改"
other = "最後更新於"
[post_edit_this]
other = "編輯此頁"
[post_view_this]
other = "查看頁面原始碼"
other = "檢視頁面原始碼"
[post_create_child_page]
other = "創建子頁面"
other = "建立子頁面"
[post_create_issue]
other = "創建文檔議題"
other = "建立文件議題"
[post_create_project_issue]
other = "創建項目議題"
other = "建立專案議題"
[post_posts_in]
other = "張貼於"
[post_reading_time]
other = " 分鐘左右可讀完"
other = " 分鐘閱讀時間"
[post_less_than_a_minute_read]
other = "1 分鐘內可讀完"

# Print support
[print_printable_section]
other = "這是本節的多頁可列印視圖"
other = "這是本節的多頁可列印檢視"
[print_click_to_print]
other = "點擊此處列印"
other = "點選此處列印"
[print_show_regular]
other = "返回此頁面的常規視圖"
other = "返回此頁面的標準檢視"
[print_entire_section]
other = "列印整個章節"

# Community
[community_join]
other = "加入 {{ .Site.Title }} 社群"
[community_introduce]
other = "{{ .Site.Title }} 是一個開源項目,社群中的任何人都可以使用、改善和盡情使用它。我們很期待你能加入我們!下面是如何查看最近更新以及參與我們的一些方式"
other = "{{ .Site.Title }} 是一個開放原始碼專案,社群中的任何人都可以使用、改進並享受其成果。我們非常歡迎您加入我們!以下是了解最新動態以及參與我們的一些方式"
[community_learn]
other = "學習和溝通"
other = "學習與交流"
[community_using]
other = "正在或打算使用 {{ .Site.Title }} ?獲取更多資訊"
other = "正在或打算使用 {{ .Site.Title }} 嗎?在此取得更多資訊"
[community_develop]
other = "開發和貢獻"
[community_contribute]
other = "如果你想通過為 {{ .Site.Title }} 貢獻更多參與,請在此處加入我們:"
other = "如果您想透過貢獻來更深入地參與 {{ .Site.Title }},請在此處加入我們:"
[community_how_to]
other = "你可以了解如何為 {{ .Site.Title }} 做出貢獻,請參考我們的"
other = "您可以透過文件了解如何為 {{ .Site.Title }} 做出貢獻,請參考我們的"
[community_guideline]
other = "貢獻指南"

# Feedback
[feedback_title]
other = "意見回饋"
[feedback_question]
other = "這個頁面對您有幫助嗎?"
[feedback_positive]
other = "有幫助"
[feedback_negative]
other = "沒幫助"
Loading

0 comments on commit 823b9bc

Please sign in to comment.