ftd.document
🚧 testftd.document
is a kernel component that provides root-level configuration to
the document. In addition to the usual document attributes like title,
theme-color, etc., it includes a range of SEO-related attributes that enhance
the accessibility of your page.
-- ftd.document:
description: My Description
og-image: https://www.fifthtry.com/assets/images/logo-fifthtry.svg
<other elements>
-- end:
ftd.document
sets the title of the document to "My
Title". The description attribute provides a brief description of the content of
the page, and og-image
specifies the image that should be displayed when the
page is shared on social media.ftd.document
ftd.document
in the ftd, it is essential to follow certain rules to
ensure that the document is structured correctly and functions as intended.ftd.document
Cannot Be a Child Componentftd.document
cannot be a child of any container components. It must be at the
root level of the document, meaning it cannot be nested within any other
component, including ftd.column
, ftd.row
, or any other container components.
Attempting to use ftd.document as a child component will result in an error.-- ftd.column:
-- ftd.document:
-- end:
-- end:
ftd.document
Can Only Occur Onceftd.document
can only occur once in the document. Attempting to use it more
than once will result in an error. This is because ftd.document
is the
root-level configuration of the document, and having multiple root-level
configurations can cause conflicts and inconsistencies.-- ftd.document:
-- end:
-- ftd.document:
-- end:
ftd.document
Cannot Have Any Siblingftd.document
element cannot have any siblings. This means that the
ftd.document
element must be the only root-level element in the document and
cannot have any other elements at the same level.-- ftd.document:
-- end:
-- ftd.text:
ftd.document
accepts the below attributes as well all the container root
attributes.title
Type: : optional
caption
title
attribute specifies the title of the document. It is displayed in
the browser's title bar or tab. The content within the title tag is crucial for
both user experience and search engine optimization (SEO) purposes.-- ftd.document:
;; or
-- ftd.document:
title: My title
og-title: optional string
The og-title
attribute provides the title of a webpage for social media
platforms and other websites when the webpage is shared or linked. The og in
og-title
stands for Open Graph, which is a protocol that allows webpages to
become rich objects in social media platforms.
title
attribute value, if not
provided explicitlyog-title
-- ftd.document:
og-title: My Page Title
twitter-title: optional string
The twitter-title
attribute provides the title of a webpage for Twitter cards.
When a webpage is shared on Twitter, the twitter-title
attribute is used to
display the title of the webpage in the Twitter card preview.
title
attribute value, if not
provided explicitly**-- ftd.document:
twitter-title: My Page Twitter Title
description: optional body
description
attribute specifies a brief summary or description of the
content of a page. The description is typically displayed in search engine
results as a preview snippet or as the description text below the page title.-- ftd.document:
description: This is a brief description of my webpage.
;; or
-- ftd.document:
This is a brief description of my webpage.
og-description: optional string
The og-description
attribute provides a brief description of a webpage for
Open Graph protocol. The Open Graph protocol is used by social media platforms,
like Facebook and LinkedIn, to display a preview of a webpage when it is shared.
description
attribute value, if not
provided explicitly**-- ftd.document:
og-description: This is the description of my webpage for Open Graph protocol.
twitter-description: optional string
The twitter-description
attribute provides a brief description of a webpage
for Twitter Cards. Twitter Cards are used by Twitter to display a preview of a
webpage when it is shared.
description
attribute value, if
not provided explicitly**-- ftd.document:
twitter-title: My Page Twitter Title
breakpoint: optional ftd.breakpoint-width-data
ftd.breakpoint-width-data
and is optional. If not specified, then the default breakpoint will be used
which is 768px
.-- ftd.document:
title: My page title
breakpoint: 800
favicon: optional ftd.raw-image-src
This attribute defines the favicon used on the document. In the scenario, where you want to use different favicons for different pages, defining this attribute will let you define it for individual pages.
Note: This value will overwrite the favicon defined at the package level insideFASTN.ftd
-- ftd.document:
title: My page title
favicon: $assets.files.doc-icon.svg.light