https://github.com/astronvim/docs

Site for AstroNvim
https://github.com/astronvim/docs

astrojs astronvim astrovim deploy docs documentation neovim starlight starlight-astro tailwind-css tailwindcss typescript website

Last synced: 8 months ago
JSON representation

Site for AstroNvim

• Host: GitHub
• URL: https://github.com/astronvim/docs
• Owner: AstroNvim
• Created: 2022-04-06T12:45:15.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2025-06-18T20:58:27.000Z (8 months ago)
• Last Synced: 2025-06-22T23:16:07.559Z (8 months ago)
• Topics: astrojs, astronvim, astrovim, deploy, docs, documentation, neovim, starlight, starlight-astro, tailwind-css, tailwindcss, typescript, website
• Language: MDX
• Homepage: https://docs.astronvim.com
• Size: 11.4 MB
• Stars: 23
• Watchers: 4
• Forks: 67
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Starlight Starter Kit: Basics

[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)

```

npm create astro@latest -- --template starlight

```

[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)

[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)

> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!

## 🚀 Project Structure

Inside of your Astro + Starlight project, you'll see the following folders and files:

```

.

├── public/

├── src/

│   ├── assets/

│   ├── content/

│   │   ├── docs/

│   │   └── config.ts

│   └── env.d.ts

├── astro.config.mjs

├── package.json

└── tsconfig.json

```

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.

Images can be added to `src/assets/` and embedded in Markdown with a relative link.

Static assets, like favicons, can be placed in the `public/` directory.

## 🧞 Commands

All commands are run from the root of the project, from a terminal:

| Command                   | Action                                           |

| :------------------------ | :----------------------------------------------- |

| `npm install`             | Installs dependencies                            |

| `npm run dev`             | Starts local dev server at `localhost:4321`      |

| `npm run build`           | Build your production site to `./dist/`          |

| `npm run preview`         | Preview your build locally, before deploying     |

| `npm run astro ...`       | Run CLI commands like `astro add`, `astro check` |

| `npm run astro -- --help` | Get help using the Astro CLI                     |

## 👀 Want to learn more?

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).