This repository has been archived by the owner on Jan 18, 2025. It is now read-only.
generated from fastn-stack/fastn-template
-
Notifications
You must be signed in to change notification settings - Fork 1
/
Copy pathbanner.ftd
228 lines (163 loc) · 6.76 KB
/
banner.ftd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
-- import: fastn-community.github.io/doc-site/assets
-- import: fastn-community.github.io/banner
-- import: fastn-community.github.io/doc-site/components
-- ds.page: Adding Banner
document-title: fastn Doc-Site Template. Build Your Own Website with Ease
document-description: Simple, easy-to-use doc-site template to build your own documentation website, personal website, or blog. Change colours and typography effortlessly.
document-image: https://fastn.com/-/fastn.com/images/fastn-logo.png
show-banner: true
sidebar: true
-- ds.page.right-sidebar:
-- components.sidebar-index:
-- end: ds.page.right-sidebar
-- ds.page.banner:
-- banner.banner:
If you like fastn, give it a ⭐️ star on [GitHub.](https://github.com/fastn-stack/fastn/)
Also, follow us on [Twitter](https://twitter.com/FifthTryHQ),
[Linkedin](https://www.linkedin.com/company/fastn-stack/),
[Instagram](https://www.instagram.com/fastn_stack/)
-- end: ds.page.banner
-- ds.page.body:
Banners are an important element of website design and can be used to enhance
the user experience, increase engagement, and drive conversions.
🌟 Ex.g. Look at the top of this page.
To learn more about banner
component - [Click here](https://fastn-community.github.io/banner/).
A [banner](https://fastn-community.github.io/banner/) is typically a horizontal
bar that appears at the very top of a webpage, often referred to as a "top banner"
or "header banner".
It usually contains important information or calls to action that are designed
to catch the user's attention and encourage them to take action.
-- ds.h2: How to enable banner on a page?
If you want to add `ds.page.banner` inside your page then refer below
code snippet.
-- ds.code: Add banner dependency into your FASTN.ftd file
lang: ftd
\-- fastn.dependency: fastn-community.github.io/banner
-- ds.code: Scroll down to view full code, click on download icon to download this code
lang: ftd
max-height.fixed.px: 300
download: page.ftd
\-- import: fastn-community.github.io/banner
\-- ds.page:
show-banner: true
\-- ds.page.banner:
\-- banner.banner:
If you like fastn, give it a ⭐️ star on [GitHub.](https://github.com/fastn-stack/fastn/)
Also, follow us on [Twitter](https://twitter.com/FifthTryHQ),
[Linkedin](https://www.linkedin.com/company/fastn-stack/),
[Instagram](https://www.instagram.com/fastn_stack/)
\-- end: ds.page.banner
\-- ds.page.body:
This is body content of your page.
\-- end: ds.page
-- ds.markdown:
Click on the download icon of the above code-block. `page.ftd` file will be
downloaded.
Then deploy or run `fastn serve` on your localhost. Access your localhost in the
browser and open `http://127.0.0.1:8000/page/` url, you will see page with a
banner as seen on top of this page.
-- ds.h2: How to enable banner on all pages?
If you want to show [banner](https://fastn-community.github.io/banner/) on all
pages and the content of your banner is same on all pages then, we recommend
modifying `FASTN/ds.ftd` global module that helps you to keep all your global
properties and configurations in one `.ftd` file.
-- ds.code: Add banner dependency into your FASTN.ftd file
lang: ftd
\-- fastn.dependency: fastn-community.github.io/banner
-- ds.h3: How to modify `FASTN/ds.ftd` module of `doc-site`?
You can modify a `FASTN/ds.ftd` module which is already added inside your
`fastn` package.
Let's learn how to modify `FASTN/ds.ftd` module:
- Edit `FASTN/ds.ftd` module and enable `show-banner: true`
- Then remove `ftd.ui list banner:` property from `page` component and add
`-- ftd.ui list page.banner` and its content inside your `FASTN/ds.ftd`
file below `-- end: page.footer` as shown in below code snippet.
-- ds.code: Scroll down to view full code, click on download icon to download this code
lang: ftd
max-height.fixed.px: 300
download: ds.ftd
\-- import: fastn-community.github.io/banner
\-- import: fastn-community.github.io/footer
\-- import: fastn-community.github.io/doc-site/common
\-- import: fastn-community.github.io/roboto-typography as typo
\-- import: fastn-community.github.io/doc-site
export: author-bio,code,compact-text,featured-post,h0,h1,h2,h3,iframe,image,image-first,image-in-between,link,link-group,markdown,not-found-1,not-found-2,output,post,posts,rendered,tip,without-image,youtube
\-- component page:
children wrapper:
optional caption title:
optional body body:
boolean sidebar: true
optional string document-title:
optional string document-description:
optional ftd.raw-image-src document-image:
optional string site-name: Doc Site
optional ftd.image-src site-logo:
boolean github-icon: true
optional string github-url: https://github.com/fastn-community/doc-site/
boolean full-width: false
ftd.type-data types: $typo.types
ftd.color-scheme colors: $ftd.default-colors
integer logo-width: $common.logo-width
integer logo-height: $common.logo-height
boolean show-footer: true
boolean show-banner: true
ftd.ui list banner:
fastn.app-ui apps: $common.apps
boolean login-button: $common.login-button
string site-url: $common.site-url
\-- ftd.ui list page.footer:
\-- footer.fastn-footer:
copyright: Copyright © 2023 - [FifthTry](https://www.fifthtry.com/)
site-logo: $common.fastn-logo
powered-by-text: Powered by
powered-by-link: https://fastn.com/
\-- end: page.footer
\-- ftd.ui list page.banner:
\-- banner.banner:
If you like fastn, give it a ⭐️ star on [GitHub.](https://github.com/fastn-stack/fastn/)
Also, follow us on [Twitter](https://twitter.com/FifthTryHQ),
[Linkedin](https://www.linkedin.com/company/fastn-stack/),
[Instagram](https://www.instagram.com/fastn_stack/)
\-- end: page.banner
\-- doc-site.page: $page.title
site-logo: $page.site-logo
body: $page.body
colors: $page.colors
sidebar: $page.sidebar
full-width: $page.full-width
types: $page.types
show-banner: $page.show-banner
show-footer: $page.show-footer
site-name: $page.site-name
logo-height: $page.logo-height
logo-width: $page.logo-width
github-icon: $page.github-icon
github-url: $page.github-url
right-sidebar: $page.right-sidebar
footer: $page.footer
banner: $page.banner
document-title: $page.document-title
document-description: $page.document-description
document-image: $page.document-image
apps: $page.apps
login-button: $page.login-button
site-url: $page.site-url
\-- ftd.column:
spacing.fixed.em: 0.8
width: fill-container
children: $page.wrapper
\-- end: ftd.column
\-- end: doc-site.page
\-- end: page
-- ds.markdown:
Click on the download icon of the above code-block. `ds.ftd` file will be
downloaded.
Replace `FASTN/ds.ftd` file with this downloaded file inside your `fastn`
project.
Then deploy or run `fastn serve` on your localhost. Access your localhost in the
browser e.g.`http://127.0.0.1:8000/` you will see all your pages with a
banner on top of every page.
To learn more about banner
component - [Click here](https://fastn-community.github.io/banner/).
-- end: ds.page