From 5a9cdbf626522c1c3323fc15543347ec007b5ebf Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Tue, 4 Jun 2024 13:30:11 -0400 Subject: [PATCH 1/3] Update all NPM packages to latest --- package.json | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/package.json b/package.json index 1589561f3..9a3ea3f46 100644 --- a/package.json +++ b/package.json @@ -33,7 +33,8 @@ "test:all": "npm run ci:prepare && npm run check && npm run cd:docs test && npm run ci:post", "test": "npm run cd:docs test", "update:dep": "npm install --save-exact @fortawesome/fontawesome-free@latest bootstrap@latest", - "update:hugo": "npm install --save-exact -D hugo-extended@latest" + "update:hugo": "npm install --save-exact -D hugo-extended@latest", + "update:pkgs": "npx npm-check-updates -u" }, "spelling": "cSpell:ignore docsy hugo fortawesome fontawesome userguide ", "dependencies": { @@ -42,10 +43,10 @@ }, "devDependencies": { "cpy-cli": "^5.0.0", - "hugo-extended": "0.126.1", - "markdown-link-check": "^3.12.1", + "hugo-extended": "0.126.3", + "markdown-link-check": "^3.12.2", "mkdirp": "^3.0.1", - "prettier": "^3.2.5" + "prettier": "^3.3.0" }, "engines": { "node": ">=20" From a29bf868649d108b19f0198d3730016291765c07 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Tue, 4 Jun 2024 13:35:49 -0400 Subject: [PATCH 2/3] fix:format --- CHANGELOG.md | 18 ++++---- .../en/docs/adding-content/lookandfeel.md | 43 +++++++++---------- userguide/package.json | 2 +- 3 files changed, 29 insertions(+), 34 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index cafa8fba9..a558b4c28 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -89,8 +89,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]. @@ -319,13 +319,12 @@ 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 @@ -433,10 +432,9 @@ 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/). diff --git a/userguide/content/en/docs/adding-content/lookandfeel.md b/userguide/content/en/docs/adding-content/lookandfeel.md index 2f1a71300..eb3c93f2c 100644 --- a/userguide/content/en/docs/adding-content/lookandfeel.md +++ b/userguide/content/en/docs/adding-content/lookandfeel.md @@ -10,10 +10,10 @@ By default, a site using Docsy has the theme's default fonts, colors, and general look and feel. However, if you want your own color scheme (and you probably will!) you can very easily override the theme defaults with your own project-specific values - Hugo will look in your project files first when -looking for information to build your site. And because [Docsy uses Bootstrap 5] -and SCSS for styling, you can override just single values (such as project -colors and fonts) in its special SCSS project variables file, or do more serious -customization by creating your own styles. +looking for information to build your site. And because [Docsy uses Bootstrap +5] and SCSS for styling, you can override just single values (such as project colors +and fonts) in its special SCSS project variables file, or do more serious customization +by creating your own styles. Docsy also provides options for styling your code blocks, using either Chroma or Prism for highlighting. @@ -77,8 +77,8 @@ Docsy has [Bootstrap][bs-docs] features such as gradient backgrounds can also be toggled in your project variables file by setting the variables to `false`. -To add colors to or modify Bootstrap's [color maps], use -**`assets/scss/_variables_project_after_bs.scss`**. For example: +To add colors to or modify Bootstrap's [color maps], use **`assets/scss/_variables_project_after_bs.scss`**. +For example: ```scss $custom-colors: ( @@ -101,9 +101,9 @@ Learn how to modify maps, see [Maps and loops] and [Adding theme colors]. ### Light/dark color themes -Docsy 0.10.0 supports light and [dark mode] color themes. To allow your website -users to choose light/dark modes, **enable the Docsy [light/dark menu]** or -create your own custom theme selector. +Docsy 0.10.0 supports light and [dark mode] color themes. To allow your website users +to choose light/dark modes, **enable the Docsy [light/dark menu]** or create +your own custom theme selector. If your site uses [Chroma for code highlighting], there are extra steps required so that code-block styles are compatible with light/dark mode: @@ -116,8 +116,7 @@ For details, see [Chroma for code highlighting]. {{% alert title="Note" %}} -Light/dark color themes, only affect documentation pages, and white [blocks -shortcodes]. +Light/dark color themes, only affect documentation pages, and white [blocks shortcodes]. [blocks shortcodes]: shortcodes/#shortcode-blocks @@ -238,8 +237,8 @@ Docsy's default Chroma styles for [light/dark mode] are: - [tango] for light mode - [onedark] for dark mode -If you would like to use other styles, save the [Hugo generated Chroma styles] -to the appropriate file: +If you would like to use other styles, save the [Hugo generated Chroma styles] to +the appropriate file: - [assets/scss/td/chroma/_light.scss] - [assets/scss/td/chroma/_dark.scss] @@ -336,8 +335,8 @@ files with your own. The default Docsy navbar (`.td-navbar`) displays your site identity, consisting of the following: -1. [Your logo][], which is included in the navbar as an inline SVG, styled by - `.td-navbar .navbar-brand svg`. For the style details, see [_nav.scss][]. +1. [Your logo][], which is included in the navbar as an inline SVG, styled by `.td-navbar .navbar-brand svg`. + For the style details, see [_nav.scss][]. To ensure your logo displays correctly, you may want to resize it and ensure that it doesn't have height and width attributes so that its size is fully @@ -368,10 +367,9 @@ switch your site's documentation page display between a default "light" mode, and a "dark" mode where the text is displayed in a light color on a dark background. -To enable the display of a light/[dark mode] menu in the navbar, set -`params.ui.showLightDarkModeMenu` to `true` in your project's configuration -file. The dropdown menu appears at the right, immediately before the [search -box], if present. +To enable the display of a light/[dark mode] menu in the navbar, set `params.ui.showLightDarkModeMenu` +to `true` in your project's configuration file. The dropdown menu appears at the +right, immediately before the [search box], if present. {{< tabpane >}} @@ -404,8 +402,8 @@ params: For pages containing a [blocks/cover][] shortcode, like most homepages, the navbar is translucent as long as the hero image hasn't scrolled up past the -navbar. For an example, see the [About Docsy][] page. This initial translucent -setting ensures that the hero image is maximally visible. +navbar. For an example, see the [About Docsy][] page. This initial translucent setting +ensures that the hero image is maximally visible. After the hero image has scrolled past the navbar, the navbar's (opaque) background color is set -- usually to the site's [primary color][]. @@ -462,8 +460,7 @@ illustrated in the following example: {.td-initial .my-dark-table-style} ``` -The example above uses [Markdown attribute][] syntax, and might render like -this: +The example above uses [Markdown attribute][] syntax, and might render like this: | Shape | Number of sides | diff --git a/userguide/package.json b/userguide/package.json index ef1aad67d..a8b0fae88 100644 --- a/userguide/package.json +++ b/userguide/package.json @@ -22,7 +22,7 @@ "postbuild:production": "npm run _check:links", "prepare": "cd .. && npm install", "serve": "npm run _serve", - "test": "npm run check:links", + "test": "npm run check:format && npm run check:links", "update:dep": "npm install --save-dev autoprefixer@latest postcss-cli@latest" }, "devDependencies": { From 57f1422591844b259f4a00e8dd0b144ff8fd171b Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Tue, 4 Jun 2024 13:38:15 -0400 Subject: [PATCH 3/3] update:pkgs for the user guide too --- package.json | 2 +- userguide/package.json | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 9a3ea3f46..efa6c1b84 100644 --- a/package.json +++ b/package.json @@ -34,7 +34,7 @@ "test": "npm run cd:docs test", "update:dep": "npm install --save-exact @fortawesome/fontawesome-free@latest bootstrap@latest", "update:hugo": "npm install --save-exact -D hugo-extended@latest", - "update:pkgs": "npx npm-check-updates -u" + "update:pkgs": "npx npm-check-updates -u && npm run cd:docs update:pkgs" }, "spelling": "cSpell:ignore docsy hugo fortawesome fontawesome userguide ", "dependencies": { diff --git a/userguide/package.json b/userguide/package.json index a8b0fae88..8126f0a20 100644 --- a/userguide/package.json +++ b/userguide/package.json @@ -23,7 +23,8 @@ "prepare": "cd .. && npm install", "serve": "npm run _serve", "test": "npm run check:format && npm run check:links", - "update:dep": "npm install --save-dev autoprefixer@latest postcss-cli@latest" + "update:dep": "npm install --save-dev autoprefixer@latest postcss-cli@latest", + "update:pkgs": "npx npm-check-updates -u" }, "devDependencies": { "autoprefixer": "^10.4.19",