Skip to content

Commit a50ded8

Browse files
lamATnginxmjangADubhlaoich
authored
feat: Add landing page archetype (#668)
This commit adds a new landing page archetype, which has the ability to display various cards to highlight specific items. The archetype includes inline guidance like other archetypes, including explanations of new frontmatter parameters and a new card shortcode. --------- Co-authored-by: Mike Jang <3287976+mjang@users.noreply.github.com> Co-authored-by: Alan Dooley <a.dooley@f5.com>
1 parent 9df3955 commit a50ded8

File tree

1 file changed

+49
-0
lines changed

1 file changed

+49
-0
lines changed

archetypes/landing-page.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
---
2+
# The title is the product name
3+
title:
4+
# The URL is the base of the deployed path, becoming "docs.nginx.com/<url>/<other-pages>"
5+
url:
6+
# The cascade directive applies its nested parameters down the page tree until overwritten
7+
cascade:
8+
# The logo file is resolved from the theme, in the folder /static/images/icons/
9+
logo:
10+
# The subtitle displays directly underneath the heading of a given page
11+
nd-subtitle:
12+
# Indicates that this is a custom landing page
13+
nd-landing-page: true
14+
# Types have a 1:1 relationship with Hugo archetypes, so you shouldn't need to change this
15+
nd-content-type: landing-page
16+
# Intended for internal catalogue and search, case sensitive:
17+
# Agent, N4Azure, NIC, NIM, NGF, NAP-DOS, NAP-WAF, NGINX One, NGINX+, Solutions, Unit
18+
nd-product:
19+
---
20+
21+
## About
22+
[//]: # "These are Markdown comments to guide you through document structure. Remove them as you go, as well as any unnecessary sections."
23+
[//]: # "Use underscores for _italics_, and double asterisks for **bold**."
24+
[//]: # "Backticks are for `monospace`, used sparingly and reserved mostly for executable names - they can cause formatting problems. Avoid them in tables: use italics instead."
25+
26+
[//]: # "This initial section introduces the product to a reader: give a short 1-2 sentence summary of what the product does and its value to the reader."
27+
[//]: # "Name specific functionality it provides: avoid ambiguous descriptions such as 'enables efficiency', focus on what makes it unique."
28+
29+
## Featured content
30+
[//]: # "You can add a maximum of three cards: any extra will not display."
31+
[//]: # "One card will take full width page: two will take half width each. Three will stack like an inverse pyramid."
32+
[//]: # "Some examples of content could be the latest release note, the most common install path, and a popular new feature."
33+
34+
{{<card-layout>}}
35+
{{<card-section showAsCards="true" isFeaturedSection="true">}}
36+
{{<card title="<some-title>">}}
37+
<!-- Each description should be roughly 10 words or less. -->
38+
{{</card>}}
39+
<!-- The titleURL and icon are both optional -->
40+
<!-- Lucide icon names can be found at https://lucide.dev/icons/ -->
41+
{{<card title="<some-title>" titleUrl="<some-url>" icon="<some-lucide-icon>">}}
42+
<!-- Each description should be roughly 10 words or less. -->
43+
{{</card>}}
44+
{{</card-section>}}
45+
{{</card-layout>}}
46+
47+
## Other content
48+
49+
[//]: # "You can add any extra content for the page here, such as additional cards, diagrams or text."

0 commit comments

Comments
 (0)