Skip to content

Commit b3f8b05

Browse files
author
dphuang2
committed
add cta docs
1 parent 4e7f037 commit b3f8b05

File tree

3 files changed

+54
-0
lines changed

3 files changed

+54
-0
lines changed
Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Configuring a Call To Action Button
2+
3+
<Figure caption="Example call-to-action button shown in the top-right of the documentation">
4+
![call-to-action-button](/img/call-to-action-button.png)
5+
</Figure>
6+
7+
To configure a call-to-action button, simpel add the `cta` property to your
8+
portal configuration. The `cta` property is an object that include a `url` and
9+
`label` for the button.
10+
11+
<CH.Code rows={20}>
12+
```yaml konfig.yaml focus=11:13
13+
outputDirectory: /tmp/acme-sdks-out
14+
specInputPath: api.yaml
15+
specPath: api-fixed.yaml
16+
portal:
17+
title: Acme
18+
primaryColor: "#1f334e"
19+
logo:
20+
light: portal-logo-light.png
21+
dark: portal-logo-dark.png
22+
googleAnalyticsId: G-XXXXXXXXXX
23+
cta:
24+
url: https://acme.com/book-a-demo
25+
label: Book A Demo
26+
documentation:
27+
sidebar:
28+
sections:
29+
- label: Guides
30+
links:
31+
- id: getting-started
32+
path: docs/getting-started.md
33+
- id: client-side-direct-api-usage
34+
path: docs/client-side-direct-api-usage.md
35+
demos:
36+
- id: getting-started
37+
path: demos/getting-started.md
38+
generators:
39+
python:
40+
version: 1.0.0
41+
packageName: acme_client
42+
projectName: acme-python-sdk
43+
outputDirectory: python
44+
clientName: Acme
45+
git:
46+
userId: konfig-dev
47+
repoId: acme-sdks/tree/main/python
48+
```
49+
</CH.Code>

generator/konfig-docs/sidebars.js

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,6 +121,11 @@ const sidebars = {
121121
label: "Configuring Google Analytics",
122122
id: "portal/tutorials/configuring-google-analytics",
123123
},
124+
{
125+
type: "doc",
126+
label: "Configuring a Call To Action",
127+
id: "portal/tutorials/configuring-a-call-to-action",
128+
},
124129
{
125130
type: "doc",
126131
label: "Configuring Custom Code",
462 KB
Loading

0 commit comments

Comments
 (0)