118 lines
4.1 KiB
YAML
118 lines
4.1 KiB
YAML
# Note: Template blocks require a 'weight' parameter so they're correctly ordered on the landing page
|
|
|
|
# Hero
|
|
hero:
|
|
enable: true
|
|
weight: 10
|
|
template: hero
|
|
|
|
backgroundImage:
|
|
path: "images/templates/hero"
|
|
filename:
|
|
desktop: "gradient-desktop.webp"
|
|
mobile: "gradient-mobile.webp"
|
|
|
|
badge:
|
|
text: v1.0
|
|
color: primary # primary, secondary, success, danger, warning, info, light, dark
|
|
pill: false # boolean
|
|
soft: true # boolean
|
|
|
|
# titleLogo:
|
|
# path: "images/logos"
|
|
# filename: "title_logo.png"
|
|
# alt: "Lotus Docs Logo"
|
|
# height: 80px
|
|
|
|
title: "Federated Enterprise"
|
|
subtitle: Everything you need to know about Federated Computer's Enterprise offerings to help you bring the best open-source SaaS software to your customers.
|
|
|
|
image:
|
|
path: "images" # path to image under configured assets directory. default 'images'
|
|
filename: "scanner.png" # filename of your hero image (including file extension)
|
|
alt: "Core Scanner" # Optional but recommended
|
|
boxShadow: true # default 'false' (excludes .svg images)
|
|
rounded: true # round the image corners? default 'false' (excludes .svg images)
|
|
|
|
ctaButton:
|
|
icon: rocket_launch
|
|
btnText: "Get Started"
|
|
url: "/docs/quickstart/#create-a-new-lotus-docs-site"
|
|
cta2Button:
|
|
icon: construction
|
|
btnText: "In Development"
|
|
url: "https://github.com/colinwilson/lotusdocs"
|
|
|
|
# Feature Grid
|
|
featureGrid:
|
|
enable: true
|
|
weight: 20
|
|
template: feature grid
|
|
|
|
title: Why Choose Federated Computer?
|
|
subtitle: Lotus Docs is a highly configurable Hugo documentation theme. Yet, with the default configuration you can deploy and publish your documentation site in a matter of minutes. Check out some core features below.
|
|
|
|
items:
|
|
- title: Fast
|
|
icon: speed
|
|
description: 4 x 100's score on Google Lighthouse by default. Lotus Docs removes unused CSS, prefetches asset links, and lazy loads content images.
|
|
ctaLink:
|
|
text: learn more
|
|
url: /docs/
|
|
|
|
- title: SEO Friendly
|
|
icon: trending_up
|
|
description: Data is automatically structured to be SEO friendly. Includes Meta tags, Opengraph, and Twitter cards. Choose the settings that best suit you.
|
|
ctaLink:
|
|
text: learn more
|
|
url: /docs/
|
|
|
|
- title: Secure by default
|
|
icon: lock
|
|
description: Lotus Docs' default configuration scores A+ on Mozilla Observatory. You can update the default Security Headers to suit your requirements.
|
|
ctaLink:
|
|
text: learn more
|
|
url: /docs/
|
|
|
|
- title: Optional Features
|
|
icon: settings
|
|
description: Many Lotus Docs features are configurable via optional parameters. Require DocSearch for your site? Then enable it via a single setting.
|
|
ctaLink:
|
|
text: learn more
|
|
url: /docs/
|
|
|
|
- title: Deploy to Vercel
|
|
icon: change_history
|
|
description: Deploy to Vercel in seconds. Vercel Functions, Vercel Redirects/Rewrites, and Vercel Headers are all configurable for an enriched experience.
|
|
ctaLink:
|
|
text: learn more
|
|
url: /docs/
|
|
|
|
- title: Dark Mode
|
|
icon: dark_mode
|
|
description: Prefer not to be blasted by the sun while reading? Switch to a low-light UI with the click of a button. Modify colour variables to match your branding.
|
|
ctaLink:
|
|
text: learn more
|
|
url: /docs/
|
|
|
|
- title: Search by DocSearch
|
|
icon: search
|
|
description: Search your docs with DocSearch. A powerful, efficient and accessible search solution built on Algolia Crawler & Autocomplete. TBC.
|
|
ctaLink:
|
|
text: learn more
|
|
url: /docs/
|
|
|
|
- title: Multilingual Support
|
|
icon: translate
|
|
description: Lotus Docs supports Hugo's Multilingual Mode. Create documentation in multiple languages side by side with i18n support.
|
|
ctaLink:
|
|
text: learn more
|
|
url: /docs/
|
|
|
|
- title: Bootstrap v5
|
|
icon: palette
|
|
description: Built on Bootstrap 5, Lotus Docs allows for a familiar, flexible, and intuitive developer experience. Easily customise your site via SCSS variables and files.
|
|
ctaLink:
|
|
text: learn more
|
|
url: /docs/
|