#remove splash page from spotlight

10 messages · Page 1 of 1 (latest)

merry crypt
#

how do I remove the splash page from spotlight and only have the docs?

worn zincBOT
#

Hi @merry crypt. I'm kapa.ai, your friendly support bot. I will try to answer your question by searching through the knowledge base. :wave:

#

To remove the splash page from your Starlight (not "Spotlight") documentation site and only have the docs, you should:

  1. Remove or modify the splash page file: The splash page is typically set up as the index.md file in your src/content/docs/ directory, often with template: splash in its frontmatter. You can either delete this file or change its frontmatter to use the default 'doc' template instead of 'splash':

    --- 
    title: Welcome
    template: doc
    ---
    
  2. Ensure your docs pages are set up: Make sure your documentation pages are present in the src/content/docs/ directory and do not use template: splash in their frontmatter.

By removing or changing the splash page’s template, your site will only display the documentation pages in the standard Starlight layout, without the splash/landing page style. The 'doc' template is the default and provides the typical documentation layout with sidebar navigation and table of contents Customizing Starlight Frontmatter Reference.

If you want your docs to start at a different page (not /), you can also adjust your content structure as described in the Starlight manual setup guide Manual Setup.

If you need to remove any hero components or other splash-specific content, simply delete or update the relevant frontmatter fields in your Markdown files Frontmatter Reference: hero.

#

If you need more specific instructions for your setup, please provide details about your current file structure.

Note: you can ask me a follow up question by @ mentioning me again :speech_balloon:

#

@merry crypt Kapa.ai is still learning and improving, please let me know how I did by reacting below.

merry crypt
#

<@&1095491216776380548> how do I change the landing page in starlight?

#

how do I change the landing page in starlight?

#

@worn zinc how do I change the landing page in starlight?

worn zincBOT
#

Let me check the knowledge base for you again. One moment! :books:

#

To change the landing page in Starlight, you should modify the content of the file that serves as your homepage. By default, this is the index.md file located in src/content/docs/. You can edit this file to change what appears on your landing page.

If you want to use a different layout (for example, remove the splash style), adjust the template field in the frontmatter:

---
title: My Landing Page
template: doc  # Use 'doc' for the standard docs layout, or 'splash' for a wide landing page
---

If you want a different page to be your landing page, you would need to rename or move your content files so that the desired page is at src/content/docs/index.md, as Starlight uses file-based routing and this file determines the root (/) of your site Customizing Starlight Manual Setup.

If you are using internationalization (i18n), the landing page for each language is the index.md file in the respective language folder (e.g., src/content/docs/en/index.mdInternationalization (i18n).

In summary:

  • Edit src/content/docs/index.md to change your landing page content and layout.
  • Use the template frontmatter to control the page style.
  • For a different landing page, move or rename your files so the desired page is at index.md.

Note: you can ask me a follow up question by @ mentioning me again :speech_balloon: