Skip to content

Commit bda1332

Browse files
committed
Update site theme
Signed-off-by: Ian Maddaus <[email protected]>
1 parent d6407f9 commit bda1332

File tree

10 files changed

+107
-17
lines changed

10 files changed

+107
-17
lines changed

_vendor/github.com/chef/chef-docs-theme/assets/sass/typography/_lists.scss

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

_vendor/github.com/chef/chef-docs-theme/assets/sass/typography/_prose.scss

Lines changed: 3 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

_vendor/github.com/chef/chef-docs-theme/assets/sass/typography/_text.scss

Lines changed: 7 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

_vendor/github.com/chef/chef-docs-theme/layouts/partials/scss.html

Lines changed: 2 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

_vendor/github.com/chef/chef-docs-theme/layouts/shortcodes/icons.html

Lines changed: 16 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

_vendor/modules.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
# github.com/chef/compliance-remediation-2022/docs-chef-io v0.0.0-20250529065228-f3ed2176e6bf
1616
# github.com/chef/license-service/docs-chef-io v0.0.0-20250120051510-ae1de80f4621
1717
# github.com/chef/samples v0.0.0-20250424163637-3393187e624c
18-
# github.com/chef/chef-docs-theme v0.0.0-20250217213320-727f9bce8258
18+
# github.com/chef/chef-docs-theme v0.0.0-20250627231523-132348230780
1919
# github.com/FortAwesome/Font-Awesome v0.0.0-20240108205627-a1232e345536
2020
# github.com/cowboy/jquery-hashchange v0.0.0-20100902193700-0310f3847f90
2121
# github.com/twitter/hogan.js v3.0.2+incompatible

content/style/shortcodes.md

Lines changed: 30 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -423,25 +423,47 @@ To format links to headings:
423423

424424
{{< /note >}}
425425

426-
## `svg` shortcode
426+
## `icons` shortcode
427427

428-
The svg shortcode will add an inline SVG icon to a string of text.
428+
The `icons` shortcode renders [Google Material Symbols](https://fonts.google.com/icons) into a page.
429429

430-
The svg shortcode takes one parameter, `file`, which is the file path to the SVG file.
430+
It accepts the following parameters:
431431

432-
For example:
432+
`icon`
433+
: The Material Symbols icon name.
434+
435+
`class`
436+
: Add the icon class.
437+
438+
Required value: `material-symbols-outlined`
439+
440+
Optional value: `icon-filled`. This renders the filled version of the icon.
441+
442+
### Examples
443+
444+
To add an icon, define the class and icon name. For example, this adds [Material Symbols description icon](https://fonts.google.com/icons?selected=Material+Symbols+Outlined:description:FILL@0;wght@400;GRAD@0;opsz@24&icon.query=description&icon.size=24&icon.color=%231f1f1f&icon.set=Material+Symbols&icon.style=Outlined):
433445

434446
```md
435-
Click on the web asset icon ({{</* svg file="/static/images/web-asset.svg" */>}}).
447+
Download {{</* icons class="material-symbols-outlined" icon="description" */>}} the file.
436448
```
437449

438-
produces:
450+
Which looks like this:
451+
452+
Download {{< icons class="material-symbols-outlined" icon="description" >}} the file.
453+
454+
You can add the [filled description icon](https://fonts.google.com/icons?selected=Material+Symbols+Outlined:description:FILL@1;wght@400;GRAD@0;opsz@24&icon.size=24&icon.color=%231f1f1f&icon.set=Material+Symbols) by adding the `icon-filled` class:
455+
456+
```md
457+
Download {{</* icons class="material-symbols-outlined icon-filled" icon="description" */>}} the file.
458+
```
459+
460+
Which looks like this:
439461

440-
Click on the web asset icon ({{< svg file="/static/images/web-asset.svg" >}}).
462+
Download {{< icons class="material-symbols-outlined icon-filled" icon="description" >}} the file.
441463

442464
## Create a new shortcode
443465

444-
Shortcode files are written in Markdown or HTML and are stored in [`layouts/shortcodes`](https://github.com/chef/chef-web-docs/tree/main/layouts/shortcodes) or [`themes/docs-new/layouts/shortcodes`](https://github.com/chef/chef-web-docs/tree/main/themes/docs-new/layouts/shortcodes) in the `chef/chef-web-docs` repository.
466+
You can create shortcodes in Markdown or HTML format in [`layouts/shortcodes`](https://github.com/chef/chef-web-docs/tree/main/layouts/shortcodes) or in the [chef/chef-docs-theme repository `layouts/shortcodes` directory](https://github.com/chef/chef-docs-theme/tree/main/layouts/shortcodes).
445467

446468
In repositories other than chef-web-docs, store shortcodes in `layouts/shortcodes/REPOSITORY_NAME/`.
447469

content/style/test.md

Lines changed: 44 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -396,13 +396,33 @@ This is a list with code blocks included with each list item:
396396
397397
Use description lists to define commands, command flags, options, or other terms. For example:
398398
399+
<!-- markdownlint-disable MD046 -->
400+
399401
term
400402
second term with same definition
401403
: Term definition.
402404
405+
```sh
406+
echo "term definition"
407+
```
408+
409+
Another paragaph.
410+
403411
plain text _(term in italics)_
404412
: Ex quis duis deserunt commodo.
405413
414+
nested item
415+
: nested item description
416+
417+
```sh
418+
echo "nested code example"
419+
```
420+
421+
And another paragraph.
422+
423+
additional nested item
424+
: This is nested three levels.
425+
406426
`code` _(`code` in italics **and bolded text in italics**)_ **and regular bolded text**
407427
: Reprehenderit eu ex dolore sunt reprehenderit ut consequat amet Lorem pariatur Lorem anim.
408428
@@ -445,6 +465,8 @@ some_term
445465
another_term
446466
: A bunch of text defining the term.
447467
468+
<!-- markdownlint-enable MD046 -->
469+
448470
### Checklists
449471
450472
Checklists are an unordered list with a checkbox.
@@ -777,15 +799,33 @@ Warnings point out something that could cause harm if ignored.
777799
The reader should proceed with caution. Ignoring this could break their deployment.
778800
{{< /danger >}}
779801
780-
## `svg` shortcode
802+
## `icons` shortcode
781803
782-
The SVG shortcode adds an inline SVG icon to a string of text:
804+
The icons shortcode adds a [Google Material Symbols icon](https://fonts.google.com/icons) to a page:
805+
806+
```md
807+
Select the web asset icon ({{</* icons class="material-symbols-outlined" icon="web_asset" */>}}).
808+
```
809+
810+
Renders the following:
811+
812+
Select the web asset icon ({{< icons class="material-symbols-outlined" icon="web_asset" >}}).
813+
814+
```md
815+
Download {{</* icons class="material-symbols-outlined" icon="description" */>}} the file.
816+
```
817+
818+
Download {{< icons class="material-symbols-outlined" icon="description" >}} the file.
819+
820+
```md
821+
Download {{</* icons class="material-symbols-outlined icon-filled" icon="description" */>}} the file.
822+
```
783823
784-
Click on the web asset icon ({{< svg file="_vendor/github.com/chef/chef-docs-theme/static/images/web-asset.svg" >}}).
824+
Download {{< icons class="material-symbols-outlined icon-filled" icon="description" >}} the file.
785825
786826
## Buttons
787827
788-
To create a link that looks like a button, just add add the `button` class to a link tag.
828+
To create a link that looks like a button, just add the `button` class to a link tag.
789829
790830
```html
791831
<a href="#buttons" class="button">Link To Button Heading</a>

go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ go 1.22
44

55
require (
66
github.com/chef/automate/components/docs-chef-io v0.0.0-20250617123043-e9e3b2463824 // indirect
7-
github.com/chef/chef-docs-theme v0.0.0-20250217213320-727f9bce8258 // indirect
7+
github.com/chef/chef-docs-theme v0.0.0-20250627231523-132348230780 // indirect
88
github.com/chef/chef-server/docs-chef-io v0.0.0-20250414141619-a0fb7ff68e94 // indirect
99
github.com/chef/chef-workstation/docs-chef-io v0.0.0-20250522055454-8df8550a2503 // indirect
1010
github.com/chef/compliance-profiles/docs-chef-io v0.0.0-20250529075927-4db22de509f8 // indirect

go.sum

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
github.com/chef/automate/components/docs-chef-io v0.0.0-20250617123043-e9e3b2463824 h1:K1jZj4ISjLOgvpGm42YrpdRHwbZQX5juZOXbwj5N+78=
22
github.com/chef/automate/components/docs-chef-io v0.0.0-20250617123043-e9e3b2463824/go.mod h1:juvLC7Rt33YOCgJ5nnfl4rWZRAbSwqjTbWmcAoA0LtU=
3-
github.com/chef/chef-docs-theme v0.0.0-20250217213320-727f9bce8258 h1:wpWL3E4Kb6ynNEwilZiKk/clD0g9AjinDB/D+OKeKHU=
4-
github.com/chef/chef-docs-theme v0.0.0-20250217213320-727f9bce8258/go.mod h1:+Jpnv+LXE6dXu2xDcMzMc0RxRGuCPAoFxq5tJ/X6QpQ=
3+
github.com/chef/chef-docs-theme v0.0.0-20250627231523-132348230780 h1:kByQrpBOatisZii/Z6rE5tQpsYdw9rrDHT2jEqkD3CE=
4+
github.com/chef/chef-docs-theme v0.0.0-20250627231523-132348230780/go.mod h1:+Jpnv+LXE6dXu2xDcMzMc0RxRGuCPAoFxq5tJ/X6QpQ=
55
github.com/chef/chef-server/docs-chef-io v0.0.0-20250414141619-a0fb7ff68e94 h1:YpF+MQ2CQ0V/sOtGrTCxa+Lpd5J9iR6ADDkrdSMqtw0=
66
github.com/chef/chef-server/docs-chef-io v0.0.0-20250414141619-a0fb7ff68e94/go.mod h1:gMSa25GUHmLimA0gjvRd3hs1buOBqkKPrdHzHvaJauY=
77
github.com/chef/chef-workstation/docs-chef-io v0.0.0-20250522055454-8df8550a2503 h1:U++vBiO8TQ6V5DZVZ8XI0WgUrnz6W/QMTGWEP3rhlaY=

0 commit comments

Comments
 (0)