Getting Started

Installation

1. Install the starlight-dot-md package in your Starlight project:

   npm

   npm install starlight-dot-md@latest

   pnpm

   pnpm add starlight-dot-md

   yarn

   yarn add starlight-dot-md

2. Add starlightDotMd() to your Astro config file:

   astro.config.mjs

   import starlight from "@astrojs/starlight";
   import { defineConfig } from "astro/config";
   import starlightDotMd from "starlight-dot-md";
   
   export default defineConfig({
     integrations: [
       starlight({
         // ...
         plugins: [starlightDotMd()],
       }),
     ],
   });

3. Start the development server:

   npm

   npm run dev

   pnpm

   pnpm run dev

   yarn

   yarn run dev

4. Access any page’s source by appending .md to its URL (e.g., for a page at /guides/example, access /guides/example.md).

Note

By default, both .md and .mdx files are served with the .md extension. Use the preserveExtension option to keep the original extension.

Tip

With Astro’s trailingSlash: "always" option, files are served at /path/index.md instead of /path.md. In development mode, you need to access URLs with a trailing slash (e.g., /path/index.md/).