Skip to content

Commit d5132bf

Browse files
committed
Update 0.14.0 release docs, rework and improve project-styles section
1 parent 11bc51a commit d5132bf

File tree

17 files changed

+370
-89
lines changed

17 files changed

+370
-89
lines changed

.markdownlint-cli2.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ globs:
1212
- 'docsy.dev/content/en/docs/best-practices/**/*.md'
1313
- 'docsy.dev/content/en/docs/get-started/other-options.md'
1414
- 'docsy.dev/content/en/docs/language.md'
15-
- 'docsy.dev/content/en/site/**/*.md'
15+
- 'docsy.dev/content/en/project/**/*.md'
1616

1717
config:
1818
extends: .markdownlint.yaml

docsy.dev/.prettierignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,6 @@
77
!/content/en/docs/best-practices/**/*.*
88
!/content/en/docs/get-started/other-options.md
99
!/content/en/docs/language.md
10-
!/content/en/site/**/*.*
10+
!/content/en/project/**/*.*
1111

1212
/layouts

docsy.dev/content/en/blog/2026/0.14.0.md

Lines changed: 149 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
title: Release 0.14.0 report and upgrade guide
33
linkTitle: Release 0.14.0
4-
date: 2026-01-16
4+
date: 2026-01-25
55
author: >-
66
[Patrice Chalin](https://github.com/chalin) ([CNCF](https://www.cncf.io/)),
77
for the [Docsy Steering Committee](/blog/2022/hello/#introducing-the-psc)
88
message: Hello, world!
99
body_class: release-highlights published-draft-post
1010
tags: [release]
11-
cSpell:ignore: Chalin docsy markdownify FOUC lookandfeel mhchem katex notoc
11+
cSpell:ignore: Chalin pageinfo docsy gohugoio subrepo lookandfeel
1212
---
1313

1414
{{% card header="Highlights" %}}
@@ -30,62 +30,137 @@ Docsy [0.14.0] comes with the following notable features and improvements:
3030

3131
- {{% _param FA globe "" %}} [Internationalization](#internationalization)
3232
improvements for multiple locales
33-
- {{% _param FA book "" %}}
34-
[Documentation enhancements](#documentation-enhancements) including Hugo
33+
- {{% _param FA book "" %}} Documentation enhancements including Hugo
3534
Markdown-style alert support
36-
- {{% _param FA code "" %}} [Hugo upgrade](#hugo-upgrade) to 0.154.5 with
37-
important breaking changes
35+
- {{% _param FA code "" %}} [Hugo upgrade](#hugo) to 0.154.5 with important
36+
breaking changes
3837

3938
## Ready to upgrade?<a id="breaking-changes"></a> {#ready-to-upgrade}
4039

4140
- Review {{% _param BADGE BREAKING warning %}} changes:
42-
- {{% _param BREAKING %}} [Hugo 0.153+ upgrade](#hugo-upgrade) introduces
43-
breaking changes
41+
- {{% _param BREAKING %}} How you [customize Swagger](#swagger-scss) UI's look
42+
and feel changes.
43+
- {{% _param BREAKING %}} [Hugo 0.153+ upgrade](#hugo) introduces breaking
44+
changes
45+
- Review changes to internal files:
46+
- [Improved separation of project and internal SCSS files](#improved-scss-soc)
4447
- Optionally skim:
4548
- {{% _param NEW %}} New features
4649
- [Other notable changes](#other-notable-changes)
4750
- {{% _param FA rocket primary %}} When you're ready, jump to
4851
[Upgrade to 0.14.0](#upgrade).
4952

50-
## {{% _param FA globe "" %}} Internationalization improvements {#internationalization}
53+
## {{% _param NEW %}} Markdown alert syntax {#alerts}
5154

52-
This release includes significant improvements to internationalization support:
53-
54-
- **Bengali localization**: Added feedback section and table of contents
55-
translations, fixed newline issues
56-
- **Serbian translations**: Updated both Cyrillic and Latin variants
57-
- **Chinese translations**: Updated Simplified and Traditional Chinese locales
58-
- **German localization**: Completed German translation support
59-
60-
These updates improve the experience for users of Docsy sites in these
61-
languages.
62-
63-
## {{% _param FA book "" %}} Documentation enhancements {#documentation-enhancements}
64-
65-
### {{% _param NEW %}} Hugo Markdown-style alert support {#alerts}
66-
67-
Docsy 0.14.0 adds support and documentation for Hugo's native Markdown-style
68-
alert syntax. This provides an alternative to the traditional shortcode-based
69-
alerts, offering a more Markdown-native approach to creating alerts in your
70-
content.
71-
72-
For details about the supported syntax, see
73-
[Hugo Markdown-style alert support](/docs/content/adding-content/#alerts).
74-
75-
### Documentation reorganization
55+
Docsy 0.14.0 adds support for Hugo's Markdown alert syntax, like this:
7656

77-
The site documentation section has been renamed to "project" section, with pages
78-
moved to the About section for better organization. This improves the structure
79-
and discoverability of project-related documentation.
80-
81-
### Additional documentation improvements
57+
```markdown
58+
> [!NOTE] :star: Markdown alert syntax
59+
>
60+
> This syntax is more author, tooling, and AI friendly.
61+
```
8262

83-
- Added **AGENTS.md** guide for AI agents working with the Docsy codebase
84-
- Added site build info and build documentation
85-
- Added version badge to documentation pages
86-
- Version tracking added to docs landing page
63+
Which renders as:
8764

88-
## {{% _param BREAKING %}} Hugo upgrade {#hugo-upgrade}
65+
> [!NOTE] :star: Markdown alert syntax
66+
>
67+
> This syntax is more author, tooling, and AI friendly.
68+
69+
While we continue to support the [alert shortcode][], we recommend using the
70+
Markdown alert syntax whenever possible. For details about the supported syntax,
71+
and how to customize the appearance of alerts, see [Alerts][].
72+
73+
[alert shortcode]: /docs/content/shortcodes/#alert
74+
[Alerts]: /docs/content/adding-content/#alerts
75+
76+
## Improved separation of project and internal SCSS files {#improved-scss-soc}
77+
78+
Docsy 0.14.0 moves all internal SCSS files from `assets/scss/` into the
79+
`assets/scss/td/` subdirectory. This change distinguishes project customization
80+
files from internal theme files and prevents projects from inadvertently
81+
overriding internal SCSS files. For details on how to customize Docsy's look and
82+
feel for your project, see [Project styles][] that covers:
83+
84+
- [Project style files][]: the files supported for project SCSS customization
85+
- [Advanced style customization][]
86+
87+
### Action required {#action-required-post-scss-file-move}
88+
89+
If your project has any of the files listed below in `assets/scss/`, you're
90+
overriding Docsy's internal SCSS files.
91+
92+
<details class="mb-3">
93+
<summary>
94+
<span class="ms-2 h5 text-info">
95+
<span class="fas fa-file-alt"></span>
96+
List of internal
97+
<code>assets/scss/</code> files moved into the <code>td/</code> subdirectory
98+
</span>
99+
</summary>
100+
101+
```text
102+
assets/scss/
103+
├── _alerts.scss
104+
├── _blog.scss
105+
├── _boxes.scss
106+
├── _breadcrumb.scss
107+
├── _code.scss
108+
├── _colors.scss
109+
├── _content.scss
110+
├── _drawio.scss
111+
├── _main-container.scss
112+
├── _nav.scss
113+
├── _navbar-mobile-scroll.scss
114+
├── _pageinfo.scss
115+
├── _search.scss
116+
├── _sidebar-toc.scss
117+
├── _sidebar-tree.scss
118+
├── _swagger.scss
119+
├── _table.scss
120+
├── _taxonomy.scss
121+
├── _variables_forward.scss
122+
├── _variables.scss
123+
├── blocks/_blocks.scss
124+
├── blocks/_cover.scss
125+
├── section-index.scss
126+
├── shortcodes.scss
127+
├── shortcodes/cards-pane.scss
128+
├── shortcodes/tabbed-pane.scss
129+
├── support/_bootstrap_vers_test.scss
130+
├── support/_mixins.scss
131+
├── support/_rtl.scss
132+
└── support/_utilities.scss
133+
```
134+
135+
</details>
136+
137+
To continue using your customizations from `_abc.scss` add the following import
138+
to your `_styles_project.scss` file:
139+
140+
```scss
141+
@import 'abc';
142+
```
143+
144+
Alternatively, you can copy the styles directly into your `_styles_project.scss`
145+
file.
146+
147+
For details about style customizations, see [Project style files][] and
148+
[Advanced style customization][].
149+
150+
## {{% _param BREAKING %}} Swagger UI style customization {#swagger-scss}
151+
152+
Prior to 0.14.0, the Docsy User Guide incorrectly recommended overriding
153+
`_swagger.scss` to customize [Swagger UI][] styles. Docsy's internal SCSS files
154+
are not intended to be overridden. The User Guide has been corrected, but since
155+
this was documented, moving the file constitutes a breaking change.
156+
157+
If your project has Swagger UI style customizations, follow the steps in
158+
[Action required](#action-required-post-scss-file-move) to continue using your
159+
customizations.
160+
161+
[Swagger UI]: /docs/content/shortcodes/#swaggerui
162+
163+
## {{% _param BREAKING %}} Hugo 0.153+ upgrade {#hugo}
89164

90165
Docsy 0.14.0 requires **Hugo 0.154.5**, upgraded from 0.152.2 in Docsy 0.13.0.
91166
This upgrade includes several breaking changes introduced in Hugo 0.153+ that
@@ -136,9 +211,30 @@ the upgrade process.
136211

137212
## Other notable changes
138213

139-
- **CI/CD improvements**: Netlify configuration moved to docsy.dev subrepo, CI
140-
cleanup and reorganization
141-
- **Package updates**: Various npm packages updated alongside the Hugo upgrade
214+
- ...
215+
216+
### {{% _param FA globe "" %}} Internationalization improvements {#internationalization}
217+
218+
This release includes significant improvements to internationalization support:
219+
220+
- **i18n file format migration**: All translation files have been converted from
221+
TOML to YAML format for better maintainability and consistency
222+
- **Bengali localization**: Added feedback section and table of contents
223+
translations, fixed newline issues, added alert labels
224+
- **Serbian translations**: Updated both Cyrillic and Latin variants
225+
- **Chinese translations**: Updated Simplified and Traditional Chinese locales,
226+
added alert labels
227+
- **German localization**: Completed German translation support
228+
- **Japanese translations**: Converted to YAML format, added alert labels and
229+
all-rights-reserved translations
230+
- **Hebrew translations**: New locale added with alert and table of contents
231+
labels
232+
- **Ukrainian translations**: Converted to YAML format
233+
- **Alert label translations**: Added across multiple locales for consistent
234+
alert messaging
235+
236+
These updates improve the experience for users of Docsy sites in these languages
237+
and make the translation files easier to maintain.
142238

143239
## {{% _param FA rocket primary %}} Upgrade to 0.14.0 {#upgrade}
144240

@@ -166,6 +262,9 @@ instead:
166262
After upgrading, review the [breaking changes](#breaking-changes) and test your
167263
site thoroughly. Pay special attention to:
168264

265+
- **SCSS file reorganization**: See
266+
[Improved separation of project and internal SCSS files](#improved-scss-soc)
267+
and [Swagger UI style customization](#swagger-scss)
169268
- **Language aliases**: Verify that default language redirects work correctly
170269
- **Page aliases**: Check that aliases point to the correct language versions
171270
- **macOS installations**: If you're on macOS, ensure Hugo is installed
@@ -217,6 +316,10 @@ Other references:
217316

218317
[0.13.0]: /project/about/changelog/#v0.13.0
219318
[0.14.0]: https://github.com/google/docsy/releases/v0.14.0?no-link-check=1
319+
[Advanced style customization]:
320+
/docs/content/lookandfeel/#advanced-style-customization
220321
[CL@0.14.0]: /project/about/changelog/#v0.14.0
322+
[Project styles]: /docs/content/lookandfeel/#project-styles
323+
[Project style files]: /docs/content/lookandfeel/#project-style-files
221324
[upgrade-0.13]: /blog/2025/0.13.0/
222325
[Upgrade to Docsy 0.13.0]: /blog/2025/0.13.0/

0 commit comments

Comments
 (0)