<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>site/README.md - fork/glide @ v0.1.0</title>
<meta name="description" content="site/README.md in fork/glide at v0.1.0.">
<meta property="og:title" content="site/README.md - fork/glide @ v0.1.0">
<meta property="og:description" content="site/README.md in fork/glide at v0.1.0.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="v0.1.0" data-tip="2bb8ae6eee01e61b0e3ad22dbf93455c15478fbe">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/glide</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/glide</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Tyler Mandry</span><span class="commit-message" data-commit="ed0a39a103df306371d35605c5fb4a64aa2bddd7">Merge pull request #15 from glide-wm/site</span><span class="snapshot-sha sha" data-commit="ed0a39a103df306371d35605c5fb4a64aa2bddd7">ed0a39a</span><time datetime="2025-07-13T20:51:50-07:00" title="2025-07-13 20:51:50 -0700">2025-07-13</time></p>
<header class="topbar"><details class="switcher"><summary>v0.1.0</summary><div class="menu"><strong>branches</strong><a href="/fork/glide/ref/main/">main</a><strong>tags</strong><a class="current" href="/fork/glide/ref/v0.1.0/">v0.1.0</a><a href="/fork/glide/ref/v0.1.1/">v0.1.1</a><a class="all" href="/fork/glide/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/glide/">glide</a> / <a href="/fork/glide/ref/v0.1.0/tree/site/">site</a> / <span class="cur">README.md</span></nav>
<span class="view-stats"><span>2.6 KiB</span><span>54 lines</span></span><span class="actions"><a class="raw" href="/fork/glide/raw/f9f6d31c6e985a13b434a837b4884e90bd5a1a9c/site/README.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>Starlight Starter Kit: Basics</h1>
<p><a href="https://starlight.astro.build"><img src="https://astro.badg.es/v2/built-with-starlight/tiny.svg" alt="Built with Starlight" /></a></p>
<pre>npm create astro@latest -- --template starlight
</pre>
<p><a href="https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics"><img src="https://developer.stackblitz.com/img/open_in_stackblitz.svg" alt="Open in StackBlitz" /></a>
<a href="https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics"><img src="https://assets.codesandbox.io/github/button-edit-lime.svg" alt="Open with CodeSandbox" /></a>
<a href="https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&amp;create_from_path=examples/basics"><img src="https://www.netlify.com/img/deploy/button.svg" alt="Deploy to Netlify" /></a>
<a href="https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&amp;project-name=my-starlight-docs&amp;repository-name=my-starlight-docs"><img src="https://vercel.com/button" alt="Deploy with Vercel" /></a></p>
<blockquote>
<p>🧑‍🚀 <strong>Seasoned astronaut?</strong> Delete this file. Have fun!</p>
</blockquote>
<h2>🚀 Project Structure</h2>
<p>Inside of your Astro + Starlight project, you'll see the following folders and files:</p>
<pre>.
├── public/
├── src/
│   ├── assets/
│   ├── content/
│   │   ├── docs/
│   └── content.config.ts
├── astro.config.mjs
├── package.json
└── tsconfig.json
</pre>
<p>Starlight looks for <code>.md</code> or <code>.mdx</code> files in the <code>src/content/docs/</code> directory. Each file is exposed as a route based on its file name.</p>
<p>Images can be added to <code>src/assets/</code> and embedded in Markdown with a relative link.</p>
<p>Static assets, like favicons, can be placed in the <code>public/</code> directory.</p>
<h2>🧞 Commands</h2>
<p>All commands are run from the root of the project, from a terminal:</p>
<table><thead><tr><th style="text-align: left">Command</th><th style="text-align: left">Action</th></tr></thead><tbody>
<tr><td style="text-align: left"><code>npm install</code></td><td style="text-align: left">Installs dependencies</td></tr>
<tr><td style="text-align: left"><code>npm run dev</code></td><td style="text-align: left">Starts local dev server at <code>localhost:4321</code></td></tr>
<tr><td style="text-align: left"><code>npm run build</code></td><td style="text-align: left">Build your production site to <code>./dist/</code></td></tr>
<tr><td style="text-align: left"><code>npm run preview</code></td><td style="text-align: left">Preview your build locally, before deploying</td></tr>
<tr><td style="text-align: left"><code>npm run astro ...</code></td><td style="text-align: left">Run CLI commands like <code>astro add</code>, <code>astro check</code></td></tr>
<tr><td style="text-align: left"><code>npm run astro -- --help</code></td><td style="text-align: left">Get help using the Astro CLI</td></tr>
</tbody></table>
<h2>👀 Want to learn more?</h2>
<p>Check out <a href="https://starlight.astro.build/">Starlight’s docs</a>, read <a href="https://docs.astro.build">the Astro documentation</a>, or jump into the <a href="https://astro.build/chat">Astro Discord server</a>.</p>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>Starlight Starter Kit: Basics</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"><a-p>npm create astro@latest -- --template starlight</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&amp;create_from_path=examples/basics)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Fbasics&amp;project-name=my-starlight-docs&amp;repository-name=my-starlight-docs)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"><a-p>&gt; 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>## </a-p><a-tt>🚀 Project Structure</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"><a-p>Inside of your Astro + Starlight project, you&#39;ll see the following folders and files:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"><a-p>├── public/</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>├── src/</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>│   ├── assets/</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>│   ├── content/</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>│   │   ├── docs/</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>│   └── content.config.ts</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>├── astro.config.mjs</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>├── package.json</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>└── tsconfig.json</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>Starlight looks for `.md` or `.mdx` files in the `src/content/docs/` directory. Each file is exposed as a route based on its file name.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>Images can be added to `src/assets/` and embedded in Markdown with a relative link.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>Static assets, like favicons, can be placed in the `public/` directory.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>## </a-p><a-tt>🧞 Commands</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"><a-p>All commands are run from the root of the project, from a terminal:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-p>| Command                   | Action                                           |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p>| :------------------------ | :----------------------------------------------- |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"><a-p>| `npm install`             | Installs dependencies                            |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"><a-p>| `npm run dev`             | Starts local dev server at `localhost:4321`      |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>| `npm run build`           | Build your production site to `./dist/`          |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"><a-p>| `npm run preview`         | Preview your build locally, before deploying     |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-p>| `npm run astro ...`       | Run CLI commands like `astro add`, `astro check` |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p>| `npm run astro -- --help` | Get help using the Astro CLI                     |</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"><a-p>## </a-p><a-tt>👀 Want to learn more?</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text">Check out [Starlight’s docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).</span></span></pre></div></div>
</main>
</body>
</html>
