gitwtfhub

wtf is starlight-dot-md?

morinokami/starlight-dot-md — explained in plain English

Analysis updated 2026-08-09 · repo last pushed 2026-04-18

4TypeScriptAudience · developerComplexity · 2/5MaintainedSetup · easy

TL;DR

An Astro Starlight plugin that serves your documentation pages as raw markdown so AI assistants like ChatGPT and Copilot can read them accurately without scraping HTML.

Mindmap

mindmap
  root((repo))
    What it does
      Serves docs as markdown
      Append dot-md to URLs
      No HTML scraping needed
    Use cases
      AI assistants read docs
      Open-source API docs
      Internal AI agent tools
    Audience
      Docs site owners
      Open-source maintainers
      Product teams
    Tech stack
      Astro
      Starlight
      TypeScript
    Setup
      Install package
      One config line
      Works automatically

Code map

Detail Auto

An interactive map of this repo's files and how they connect — its source is parsed live in your browser. Click Visualize to build it.

filefunction / class

Why would anyone build with this?

REASON 1

Make your Astro Starlight docs readable by AI assistants like Copilot and ChatGPT.

REASON 2

Let internal AI agents pull fresh documentation as clean markdown instead of scraping HTML.

REASON 3

Give open-source projects a machine-readable docs endpoint with zero duplicate content.

What's in the stack?

TypeScriptAstroStarlight

How it stacks up

morinokami/starlight-dot-md0labs-in/vision-linkadarsh-me/image-sdk
Stars444
LanguageTypeScriptTypeScriptTypeScript
Last pushed2026-04-18
MaintenanceMaintained
Setup difficultyeasymoderateeasy
Complexity2/53/52/5
Audiencedeveloperdeveloperdeveloper

Figures from each repo's GitHub metadata at analysis time.

How do you spin it up?

Difficulty · easy Time to first run · 5min

Install the package and add one line to your Astro config file, no extra endpoints or duplicated content needed.

The explanation does not mention a license for this repository.

Wtf does this do

Starlight-dot-md is a plugin that makes your documentation accessible to AI agents in a format they can actually use. If you run a documentation site built with Astro Starlight, this tool lets any AI assistant read your docs as raw markdown instead of trying to parse a rendered web page. Normally, when someone visits your docs site, they see a nicely formatted web page with navigation bars, styling, and other browser-friendly elements. That's great for humans but messy for AI tools that work better with plain text. This plugin solves that by creating a simple alternative: append .md to any page URL and you get the underlying markdown source file instead of the formatted HTML. So a page at /guides/getting-started becomes available at /guides/getting-started.md as clean, unstyled markdown. The people who benefit most here are teams whose docs are meant to be consumed by AI-powered tools. If you run an open-source project and want coding assistants like GitHub Copilot or ChatGPT to understand your API documentation, this gives them a direct path to read it accurately. Product teams building internal tools on top of AI agents could also use it to let those agents pull fresh documentation without scraping HTML and guessing at structure. Setup is minimal. You install the package, add one line to your Astro configuration file to enable the plugin, and it works automatically across all your documentation pages. There are no extra endpoints to maintain or content to duplicate. The README doesn't go into detail about edge cases or performance considerations, but the core idea is straightforward: serve the same content two ways, one for humans and one for machines.

Yoink these prompts

Prompt 1
I have an Astro Starlight docs site. Help me install and configure the starlight-dot-md plugin so my pages are served as raw markdown at dot-md URLs.
Prompt 2
Write a fetch call that retrieves my getting-started guide as markdown from /guides/getting-started.md and feeds it to an AI assistant for summarization.
Prompt 3
Compare the HTML output and markdown output of my Starlight docs page so I can verify the starlight-dot-md plugin is working correctly.
Prompt 4
Help me set up a GitHub Copilot custom instruction that tells it to append dot-md to my docs URLs and read the raw markdown for context.

Frequently asked questions

wtf is starlight-dot-md?

An Astro Starlight plugin that serves your documentation pages as raw markdown so AI assistants like ChatGPT and Copilot can read them accurately without scraping HTML.

What language is starlight-dot-md written in?

Mainly TypeScript. The stack also includes TypeScript, Astro, Starlight.

Is starlight-dot-md actively maintained?

Maintained — commit in last 6 months (last push 2026-04-18).

What license does starlight-dot-md use?

The explanation does not mention a license for this repository.

How hard is starlight-dot-md to set up?

Setup difficulty is rated easy, with roughly 5min to a first successful run.

Who is starlight-dot-md for?

Mainly developer.

View the repo → Decode another repo

This repo across BitVibe Labs

Don't trust strangers blindly. Verify against the repo.