Answer the following questions to configure your new Starlight project.
The project name is a short name that represents the project. It will be the folder name. Keep it short, lowercase, use dashes (not spaces) to separate words, and avoid special characters.
The site URL is the final deployed URL for your site. It is used to generate your sitemap and canonical URLs in your final build. Note that if you do not know this, put something reasonable in for now and you can change it later.
The title is brief and descriptive text for the site. It will appear on Search Engine Results Pages (SERPs), and will be the part of the browser tab title.
The description is a short snippet of text that summarizes the content. It appears beneath the page title in Search Engine Results Pages (SERPs). It is an important element for Search Engine Optimization (SEO) because it can significantly impact click-through rates.
The package manager is a build tool that automates the process of installing, updating, configuring, and managing software packages or libraries.
The TypeScript Mode is a settting for controlling the level of type checking strictness. (Strict is recommended.)
Enabling git will initialize a local git repo, creating a .git folder.
Biome is a build plugin that can format and lint source code.
Starlight plugin to add a blog to your documentation.
Enable easy diagram generation using D2 Markdown code blocks.
Dependabot is a GitHub feature that monitors software dependencies for updates and security vulnerabilities.
Configure a GitHub Action script to build the project upon changes being pushed to GitHub.
Easily add badges to your Markdown and MDX headings that are also visible in the table of contents.
Add zoom capabilities to your documentation images.
Starlight plugin to validate internal links.
Generate llms.txt files to train large language models on your documentation.
Astro library to get the Lucide.dev icons.
Enable content authoring using Markdoc.
Render MathJax mathematic syntax in Markdown content.
Enable easy diagram generation using Mermaid Markdown code blocks.
Display npm related commands for multiple package managers.
The single platform to analyze, test, observe, and deploy new features.
Set of Starlight components to author showcase pages.
Add support for Tailwind CSS utility classes.
These optional frameworks are offered as a convenience.
The user interface frameworks are optional, but they enable adding interactive components to your site. Unless you know what these are and have clear intentions to leverage them, you can leave them unchecked. Note that you may not choose more than one JSX framework (Preact, React, Solid) because JSX settings in tsconfig.json are unique for each framework.
Starlight can display links to related social media accounts. They appear as icon links in the site header.