Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update all NPM packages to latest, add update:pkgs script and more #2034

Merged
merged 3 commits into from
Jun 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 8 additions & 10 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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].
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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/).
Expand Down
9 changes: 5 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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 && npm run cd:docs update:pkgs"
},
"spelling": "cSpell:ignore docsy hugo fortawesome fontawesome userguide ",
"dependencies": {
Expand All @@ -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",
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very nice that npm-check-updates -u respects the pinned nature of hugo-extended!

"markdown-link-check": "^3.12.2",
"mkdirp": "^3.0.1",
"prettier": "^3.2.5"
"prettier": "^3.3.0"
},
"engines": {
"node": ">=20"
Expand Down
43 changes: 20 additions & 23 deletions userguide/content/en/docs/adding-content/lookandfeel.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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: (
Expand All @@ -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:
Expand All @@ -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

Expand Down Expand Up @@ -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]
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.

<!-- prettier-ignore -->
{{< tabpane >}}
Expand Down Expand Up @@ -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][].
Expand Down Expand Up @@ -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:

<!-- prettier-ignore-start -->
| Shape | Number of sides |
Expand Down
5 changes: 3 additions & 2 deletions userguide/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,9 @@
"postbuild:production": "npm run _check:links",
"prepare": "cd .. && npm install",
"serve": "npm run _serve",
"test": "npm run check:links",
"update:dep": "npm install --save-dev autoprefixer@latest postcss-cli@latest"
"test": "npm run check:format && npm run check:links",
"update:dep": "npm install --save-dev autoprefixer@latest postcss-cli@latest",
"update:pkgs": "npx npm-check-updates -u"
},
"devDependencies": {
"autoprefixer": "^10.4.19",
Expand Down