Skip to content

Commit 029fb3f

Browse files
committed
ExampleSite: Add Everything page
Remove unused shortcodes (checked documentation and NIC repos) Add initial spacing
1 parent d727a19 commit 029fb3f

File tree

13 files changed

+284
-34
lines changed

13 files changed

+284
-34
lines changed

assets/css/v2/style.css

Lines changed: 62 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@
3636
--sidebar-width: 24rem;
3737
--sidebar-line-width: 11.5px;
3838
--side-gutter-width: 20rem;
39-
--table-top-bottom-spacing: 3rem;
39+
--table-top-bottom-spacing: 1rem;
4040
--table-row-space-between: 1.5rem;
4141
--table-min-column-spacing-narrow: 1.5rem;
4242
--table-min-column-spacing-wide: 0.75rem;
@@ -56,8 +56,32 @@
5656
--component-gap: 3.5rem;
5757
--overflow-gutter-extension: 1rem;
5858
}
59-
body {
59+
60+
html,
61+
body,
62+
p,
63+
ol,
64+
ul,
65+
li,
66+
dl,
67+
dt,
68+
dd,
69+
blockquote,
70+
figure,
71+
fieldset,
72+
legend,
73+
textarea,
74+
pre,
75+
iframe,
76+
hr,
77+
h1,
78+
h2,
79+
h3,
80+
h4,
81+
h5,
82+
h6 {
6083
margin: 0;
84+
padding: 0;
6185
}
6286

6387
@supports (font-variation-settings: normal) {
@@ -91,6 +115,22 @@ p {
91115
font-weight: 400;
92116
}
93117

118+
ul,
119+
ol {
120+
padding: 0;
121+
margin: 0;
122+
}
123+
124+
ul li,
125+
ol li {
126+
margin-bottom: 0.5rem;
127+
}
128+
129+
ul li:last-child,
130+
ol li:last-child {
131+
margin-bottom: 0;
132+
}
133+
94134
/* layout */
95135
header {
96136
margin: 2rem 2rem 0 2rem;
@@ -261,6 +301,7 @@ nav {
261301
grid-template-columns: var(--text-content-width-iphone-13) 1fr;
262302
margin-top: 2rem;
263303
grid-auto-rows: max-content;
304+
grid-gap: 1rem;
264305
}
265306

266307
.text-content > :not(.wide) {
@@ -793,7 +834,7 @@ main {
793834
}
794835

795836
p {
796-
margin: 0 0 1.5rem 0;
837+
margin: 0;
797838
line-height: 1.5rem;
798839
}
799840

@@ -836,12 +877,12 @@ a:hover {
836877

837878
h1 {
838879
font-size: 2rem;
839-
margin: 0 0 2rem 0;
880+
margin: 0 0 1rem 0;
840881
}
841882

842883
h2 {
843884
font-size: 1.5rem;
844-
margin: 0 0 1rem 0;
885+
margin: 1rem 0 .75rem 0;
845886
}
846887

847888
/* tables */
@@ -910,7 +951,7 @@ table hr {
910951
blockquote {
911952
border: 1px solid var(--color-foreground);
912953
padding: 1rem;
913-
margin: 0 -1rem;
954+
margin: 1rem -1rem;
914955

915956
/* solid 3px drop shadow */
916957
box-shadow: 3px 3px 0px var(--color-shadow);
@@ -959,6 +1000,13 @@ blockquote.side-callout {
9591000
grid-row: span 2;
9601001
}
9611002

1003+
/* blockquote doesn't have an internal grid
1004+
so grid-gap won't handle the spacing */
1005+
blockquote ol,
1006+
blockquote ul {
1007+
margin: 0 0 1rem 1rem;
1008+
}
1009+
9621010
/* Tabs */
9631011
.tabs-container {
9641012
/* border-bottom: 1px solid black; */
@@ -1037,6 +1085,7 @@ blockquote.side-callout {
10371085
border: 1px solid var(--color-tabs-divider);
10381086
border-bottom: 1px solid black;
10391087
padding: 10px;
1088+
margin-bottom: 0;
10401089

10411090
a {
10421091
text-decoration: none;
@@ -1066,6 +1115,7 @@ blockquote.side-callout {
10661115

10671116
.tab-content {
10681117
border-bottom: 1px solid black;
1118+
padding-bottom: 1rem;
10691119

10701120
.tab-pane {
10711121
display: none;
@@ -1096,17 +1146,13 @@ blockquote.side-callout {
10961146
margin-top: -1.5rem;
10971147
}
10981148

1099-
li .code-block {
1100-
/* For indented code blocks, move 1rem back to align code with text from heading */
1101-
margin-left: -1rem;
1102-
}
1103-
11041149
.highlight-v2 {
11051150
border-top: 1px solid #cccccc;
11061151
border-bottom: 1px solid #cccccc;
11071152
overflow-x: scroll;
11081153
scrollbar-width: none;
11091154
line-height: 1.3rem;
1155+
padding: 1rem 0;
11101156
}
11111157

11121158
.highlight-v2.single-line {
@@ -1140,6 +1186,11 @@ li .code-block {
11401186
position: relative;
11411187
}
11421188

1189+
ol .code-container,
1190+
ul .code-container {
1191+
margin-top: 0.75rem;
1192+
}
1193+
11431194
.code-container:hover {
11441195
.code-copy-button {
11451196
display: block;

exampleSite/content/includes/index.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
---
2+
headless: true
3+
---
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
You can find more information about the NGINX Plus OpenID Connect integration in the project's [GitHub repo](https://github.com/nginxinc/nginx-openid-connect#nginx-openid-connect).

exampleSite/content/test-product/_index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,5 @@
22
description: Test pages for nginx-hugo-theme
33
title: Test pages for nginx-hugo-theme
44
weight: 100
5+
toc: true
56
---
Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
---
2+
description: Single Line Codeblock Spacing
3+
title: Single Line Codeblock Spacing
4+
weight: 200
5+
---
6+
7+
This is a line.
8+
9+
```shell
10+
sudo rm -rf /
11+
```
12+
13+
This is the line that follows. Great.
14+
15+
## `h2` - Headers followed by codeblocks
16+
```shell
17+
sudo rm -rf /
18+
```
19+
### `h3` - Header
20+
```shell
21+
sudo rm -rf /
22+
```
23+
#### `h4` - Header
24+
```shell
25+
sudo rm -rf /
26+
```
27+
28+
## Order List with single line code block
29+
30+
31+
1. Create the `/etc/ssl/nginx` directory:
32+
33+
```shell
34+
sudo mkdir -p /etc/ssl/nginx
35+
```
36+
37+
1. Log in to [MyF5 Customer Portal](https://account.f5.com/myf5/) and download your `nginx-repo.crt` and `nginx-repo.key` files.
38+
39+
1. Copy the files to the `/etc/ssl/nginx/` directory:
40+
41+
```shell
42+
sudo cp nginx-repo.crt nginx-repo.key /etc/ssl/nginx/
43+
```
44+
45+
1. Install the prerequisites:
46+
47+
```shell
48+
sudo yum install yum-utils procps
49+
```
50+
51+
1. Set up the yum repository by creating the file `nginx-agent.repo` in `/etc/yum.repos.d`, for example using `vi`:
52+
53+
```shell
54+
sudo vi /etc/yum.repos.d/nginx-agent.repo
55+
```
56+
57+
1. Add the following lines to `nginx-agent.repo`:
58+
59+
```ini
60+
[nginx-agent]
61+
name=nginx agent repo
62+
baseurl=https://pkgs.nginx.com/nginx-agent/centos/$releasever/$basearch/
63+
sslclientcert=/etc/ssl/nginx/nginx-repo.crt
64+
sslclientkey=/etc/ssl/nginx/nginx-repo.key
65+
gpgcheck=0
66+
enabled=1
67+
```
68+
69+
## Text with Ordered List in note
70+
71+
- **Using an instance's configuration for the group configuration**: If an instance is the first to join a config sync group and the group's configuration hasn't been defined, the instance’s configuration will become the group’s configuration. Any instances added later will automatically inherit this configuration.
72+
73+
{{< note >}} If you add multiple instances to a single config sync group, simultaneously (with automation), follow these steps. Your instances will inherit your desired configuration:
74+
75+
1. Create a config sync group.
76+
1. Add a configuration to the config sync group, so all instances inherit it.
77+
1. Add the instances in a separate operation.
78+
79+
Your instances should synchronize with your desired configuration within 30 seconds. {{< /note >}}
Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
---
2+
description: Everything
3+
title: Everything
4+
weight: 200
5+
---
6+
7+
## before-you-begin
8+
9+
{{< before-you-begin >}}
10+
Before you can set users' passwords, ensure you have [created users](#create-users) in NGINX Instance Manager. Once you've created the users, you can use one of the following options to set their passwords.
11+
{{< /before-you-begin >}}
12+
13+
## bootstrap-table
14+
15+
{{<bootstrap-table "table">}}
16+
| Method | Endpoint |
17+
|--------|---------------------------------------------------------------------|
18+
| GET | `/api/platform/v1/systems/{systemUID}/instances` |
19+
| POST | `/api/platform/v1/security/{systemUID}/instances/{nginxUID}/config` |
20+
{{</bootstrap-table>}}
21+
22+
## call-out
23+
24+
{{<call-out "tip" "Enhanced templating with Sprig">}}
25+
<i class="fas fa-code-branch"></i>
26+
Go templating in Instance Manager includes support for the [Sprig function library](https://masterminds.github.io/sprig/), offering a wide range of additional functions that can be used in templates for advanced operations like string manipulation, data conversion, mathematics, and more.
27+
{{</call-out>}}
28+
29+
## caution
30+
31+
{{<caution>}}
32+
Enabling logs using the **NGINX Logs** blade on your NGINXaaS deployment is now deprecated. This feature will be removed in an upcoming update. If you have issues accessing your NGINX logs using the deprecated method, please follow the steps in this guide to access your NGINX logs.
33+
{{</caution>}}
34+
35+
36+
## comment
37+
38+
This one literally stops the contents being rendered... It's for markdown comments.
39+
{{<comment>}}
40+
This won't render anything.
41+
{{</comment>}}
42+
43+
## deprecated
44+
45+
{{< deprecated >}}Using the helper.sh script to download your NGINX Plus certificate and key bundle is deprecated in in NGINX Controller v3.9.{{< /deprecated >}}
46+
47+
## download
48+
49+
{{< download "ngf/grafana-dashboard.json" "ngf-grafana-dashboard.json" >}}
50+
51+
## img
52+
53+
{{< img src="hero-graphic.webp" caption="hero-graphic" width="50%">}}
54+
55+
## important
56+
57+
{{< important >}}If the fingerprint is different, remove the file.{{< /important >}}
58+
59+
## include
60+
61+
{{< include "nginx-openid-repo-note.txt" >}}
62+
63+
## see-also
64+
65+
{{< see-also >}}See also!{{< /see-also >}}
66+
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
2+
---
3+
description: Note with content
4+
title: Note with content
5+
weight: 200
6+
---
7+
8+
9+
## Text with Ordered List in note
10+
11+
- **Using an instance's configuration for the group configuration**: If an instance is the first to join a config sync group and the group's configuration hasn't been defined, the instance’s configuration will become the group’s configuration. Any instances added later will automatically inherit this configuration.
12+
13+
{{< note >}} If you add multiple instances to a single config sync group, simultaneously (with automation), follow these steps. Your instances will inherit your desired configuration:
14+
15+
1. Create a config sync group.
16+
1. Add a configuration to the config sync group, so all instances inherit it.
17+
1. Add the instances in a separate operation.
18+
19+
Your instances should synchronize with your desired configuration within 30 seconds. {{< /note >}}
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
---
2+
title: Short Page
3+
description: "Short Page"
4+
weight: 200
5+
---
6+
7+
See the NGINX Gateway Fabric technical specifications page:
8+
9+
<https://github.com/nginx/nginx-gateway-fabric#technical-specifications>

0 commit comments

Comments
 (0)