Skip to content

Commit afbded8

Browse files
danielledeleonginx-jack
authored andcommitted
Callout: Add example site page
1 parent bf7d5ad commit afbded8

File tree

3 files changed

+67
-2
lines changed

3 files changed

+67
-2
lines changed

Diff for: exampleSite/content/test-product/_index.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
22
description: Test pages for nginx-hugo-theme
3-
title: Test pages for nginx-hugo-theme
3+
title: Test pages
44
weight: 100
55
---
+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
2+
---
3+
description: All Callouts
4+
title: All Callouts
5+
weight: 100
6+
---
7+
8+
9+
## Plain Callouts
10+
These are the main callout types that may be used to bring attention to a section of text. You should prefer to use [Side Callouts](#side-callouts) instead.
11+
12+
{{<call-out>}}
13+
This is a plain callout with no title. It has a [link](#plain-callouts) to a heading on this page. Its shortcode is `<call-out>`.
14+
{{</call-out>}}
15+
16+
{{<call-out "" "Custom title">}}
17+
This is a plain callout with a title. It has a [link](#plain-callouts) to a heading on this page. Its shortcode is `<call-out>` with a custom title parameter.
18+
{{</call-out>}}
19+
20+
{{<before-you-begin>}}
21+
This is a plain callout with a default title for its type. It has a [link](#plain-callouts) to a heading on this page. Its shortcode is `<before-you-begin>`.
22+
{{</before-you-begin>}}
23+
24+
## Side Callouts
25+
26+
Naturally, callouts should contain less text within them than the text it lives next to. We do this for several reasons. Firstly, it looks weird to have a big empty space in the primary content area. Secondly, if you have more text in the callout, then it stops being a callout. I have asked an LLM to lengthen this passage.
27+
28+
{{<call-out "side-callout">}}
29+
This is a plain side callout with no title. It has a [link](#plain-callouts) to a heading on this page. Its shortcode is `<call-out>` with the `.side-callout` class.
30+
{{</call-out>}}
31+
32+
When designing effective web layouts, it's important to maintain proper balance between primary content and supplementary elements. Callouts serve as attention-grabbing devices that highlight key information, but they should remain subordinate to the main content flow. This hierarchy helps users navigate your page intuitively, guiding their attention appropriately. A well-designed callout complements the surrounding text rather than competing with it.
33+
34+
Additionally, concise callouts tend to be more effective at capturing user attention. When a callout becomes too verbose, users are less likely to read it entirely, defeating its purpose. The visual weight of callouts should align with their informational importance - brief, impactful statements create better engagement than lengthy explanations. Remember that white space itself is a powerful design element, creating visual breathing room that enhances readability and focus. Ultimately, the most successful callouts follow the principle of "less is more," delivering maximum impact through minimal interruption to the user's reading experience.
35+
36+
{{<call-out "side-callout" "Custom title">}}
37+
This is a plain side callout with a custom title. It has a [link](#plain-callouts) to a heading on this page. Its shortcode is `<call-out>` with the `.side-callout` class, and a custom title.
38+
{{</call-out>}}
39+
40+
## Important, but not urgent
41+
42+
This is a weird exception callout that adds just a little extra contrast to the callout.
43+
44+
{{<important>}}
45+
This is an Important callout. There was previously a bug with **bold text** that we should be aware of and continue to check for. This callout was invoked with the `<warning>` shortcode. It has no custom title.
46+
{{</important>}}
47+
48+
## Loud Callouts
49+
50+
These callouts should be used sparingly: only when it is imperative to capture the user's attention.
51+
52+
{{<caution>}}
53+
This is a Caution callout. There was previously a bug with **bold text** that we should be aware of and continue to check for. This callout was invoked with the `<caution>` shortcode. It has no custom title.
54+
{{</caution>}}
55+
56+
This callout especially should be used **VERY** judiciously.
57+
58+
{{<warning>}}
59+
This is a Warning callout. There was previously a bug with **bold text** that we should be aware of and continue to check for. This callout was invoked with the `<warning>` shortcode. It has no custom title.
60+
{{</warning>}}
61+
62+
63+
{{<call-out "warning" "Custom warning title">}}
64+
This is a Warning callout with a custom title. There was previously a bug with **bold text** that we should be aware of and continue to check for. This callout was invoked with the `<call-out>` shortcode with the `.warning` class, and a custom title.
65+
{{</call-out>}}

Diff for: exampleSite/hugo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
baseURL = 'https://nginx.org'
22
languageCode = 'en-us'
3-
title = 'nginx-hugo-theme example site'
3+
title = 'Example Site'
44

55

66
[module]

0 commit comments

Comments
 (0)