Skip to content

Commit

Permalink
docs: README
Browse files Browse the repository at this point in the history
  • Loading branch information
ido-pluto committed Nov 21, 2023
1 parent c6369f3 commit bf25e8c
Showing 1 changed file with 13 additions and 42 deletions.
55 changes: 13 additions & 42 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,53 +1,24 @@
# 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!
<div align="center">

## πŸš€ Project Structure
# Astro Utils Docs

Inside of your Astro + Starlight project, you'll see the following folders and files:
<img src="./public/favicon.png" height="200" />

```
.
β”œβ”€β”€ 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.
[![Built with Astro](https://astro.badg.es/v2/built-with-astro/tiny.svg)](https://astro.build)
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)

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

## 🧞 Commands
This is the documentation for the Astro Utils project.

All commands are run from the root of the project, from a terminal:
It is built with [Astro](https://astro.build) and [Starlight](https://starlight.astro.build).

| 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?
### Development

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).
```bash
npm install
npm run dev
```

0 comments on commit bf25e8c

Please sign in to comment.