Configuration Reference

This document describes the available configuration options for your site. These settings are defined in the config.ts file and control various aspects of your site’s behavior and appearance. Below is a detailed reference for each configuration property, including examples where applicable.

Site Configuration

website

• Type: string
• Description: The URL of your site. Replace this with the deployed domain of your site to direct users to the correct address.
• Example: "https://hyperoot.dev"

author

• Type: string
• Description: The name of the author or creator of the site. This value will be used to attribute content and provide credit.
• Example: "HYP3R00T"

desc

• Type: string
• Description: A brief description of your site. This summary provides context and information about the purpose and content of the site.
• Example: "Documentation template using Astro and Shadcn"

title

• Type: string
• Description: The title of your site. This will be displayed in the browser tab and used for branding purposes.
• Example: "CelestialDocs"

ogImage

• Type: string
• Description: The filename of the image used for Open Graph (OG) sharing. This image will be shown when your site is shared on social media platforms.
• Example: "og-image.jpg"

repo

• Type: string
• Description: The URL to the repository hosting the source code of your site. This provides a link to where the site’s code can be found.
• Example: "https://github.com/HYP3R00T/CelestialDocs"

Locale Configuration

lang

• Type: string
• Default: "en"
• Description: The HTML language code for your site. Set this to specify the language used for the content. If left empty, it defaults to "en".
• Example: "en" (for English)

langTag

• Type: array of strings
• Default: ["en-EN"]
• Description: BCP 47 language tags used to specify the language and regional variations. Set this to customize the language settings. An empty array defaults to the environment’s default language.
• Example: ["en-EN"] for English (United Kingdom)

Menu Configuration

menu_items

• Type: array of objects
• Description: An array of menu items for the site’s navigation. Each item should have a title and href to define the menu link. This is currently empty but can be populated to create navigation links.
• Example:

  export const menu_items = [
    { title: "Home", href: "/" },
    { title: "About", href: "/about" },
    { title: "Contact", href: "/contact" },
  ];
  

Sidebar Navigation Configuration

side_nav_menu_order

• Type: array of strings
• Description: An array defining the order of items in the sidebar navigation. The list should contain top-level folders and files (without extensions) to organize the sidebar menu.
• Example:

  export const side_nav_menu_order = [
    "getting-started",
    "guides",
    "custom-components",
    "reference",
  ];
  

Global Settings

hide_table_of_contents

• Type: boolean
• Default: false
• Description: Controls whether the Table of Contents (ToC) is hidden. Set this to true to prevent the ToC from being displayed.
• Example: true (to hide the ToC)

hide_breadcrumbs

• Type: boolean
• Default: false
• Description: Determines whether breadcrumbs should be hidden. Setting this to true will hide breadcrumbs from the site’s pages.
• Example: true (to hide breadcrumbs)

hide_side_navigations

• Type: boolean
• Default: false
• Description: Controls whether sidebar navigation should be hidden. Setting this to true will hide the sidebar.
• Example: true (to hide sidebar navigation)

hide_datetime

• Type: boolean
• Default: false
• Description: Indicates whether the date and time should be hidden. If set to true, date and time information will not be displayed.
• Example: true (to hide date and time)

hide_time

• Type: boolean
• Default: true
• Description: Controls whether the time should be hidden. This is set to true by default to omit time information from being shown.
• Example: false (to show time)

hide_search

• Type: boolean
• Default: false
• Description: Determines if the search functionality should be hidden. Setting this to true will remove the search feature from the site.
• Example: true (to hide the search feature)

hide_repo_button

• Type: boolean
• Default: false
• Description: Controls whether the repository button is hidden. If set to true, the button linking to the repository will not be displayed.
• Example: true (to hide the repository button)

hide_author

• Type: boolean
• Default: false
• Description: Specifies whether the author’s information should be hidden. Setting this to true will prevent the author’s details from being shown.
• Example: true (to hide author information)

You can append the following section to your existing documentation:

---

Social Configuration

• Type: array of objects

• Description: An array defining the social media links that will appear in the footer of your site. Each object in the array should include name, href, linkTitle, and active properties to specify the social media platform, link, title, and whether the link is active.

• Example:

  export const Socials: SocialObjects = [
    ...
    {
      name: "Github",
      href: "https://github.com/HYP3R00T/",
      linkTitle: `${SITE.title} on Github`,
      active: true,
    },
    ...
  ];
  

This reference guide provides a comprehensive overview of the configuration options available for your site. Adjust these settings as needed to customize the appearance and behavior of your site according to your preferences.