Starlight Starter
Start a new Starlight project
Configure
Purchase
Receive Product
Answer the following questions to configure your new Starlight project.
What is your Project Name?
Required
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.
What will the URL be for your site?
Required
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.
What is your Title?
Required
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.
What is your Description?
Optional
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.
Which Package Manager would you like to use?
Required
pnpm
yarn
npm
The package manager is a tool that automates the process of installing, updating, configuring, and managing software packages or libraries.
Which TypeScript Mode would you like to use?
Required
Relaxed
Strict
Strictest
The TypeScript Mode is a settting for controlling the level of type checking strictness. (Strict is recommended.)
Would you like git enabled?
Required
Git
Enabling git will initialize a local git repo, creating a
.git
folder.
Which options would you like to include?
Optional
Blog
Starlight plugin to add a blog to your documentation.
Lucide
Astro library to get the Lucide.dev icons.
PostHog
The single platform to analyze, test, observe, and deploy new features.
Showcases
Set of Starlight components to author showcase pages.
Tailwind
Add support for Tailwind CSS utility classes.
These optional frameworks are offered as a convenience.
Which user interface frameworks would you like to use?
Optional
Preact
React
Solid
Svelte
Vue
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 unqiue for each framework.
Which Social Links would you like to include?
Optional
Discord
discord
Email
email
Facebook
facebook
Github
github
Instagram
instagram
Linkedin
linkedin
Open Collective
openCollective
Patreon
patreon
X.com
twitter
Youtube
youtube
Click to show/hide more options
Azure Dev Ops
azureDevOps
Bitbucket
bitbucket
Blue Sky
blueSky
Codeberg
codeberg
Code Pen
codePen
Discourse
discourse
Gitlab
gitlab
Gitter
gitter
Hacker One
hackerOne
Mastodon
mastodon
Matrix
matrix
Microsoft Teams
microsoftTeams
Pinterest
pinterest
Reddit
reddit
Signal
signal
Slack
slack
Stack Overflow
stackOverflow
Telegram
telegram
Threads
threads
Tiktok
tiktok
Twitch
twitch
Zulip
zulip
Starlight can display links to related social media accounts. They appear as icon links in the site header.