Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Astro docs #1096

Merged
merged 27 commits into from
Nov 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 20 additions & 0 deletions apps/docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# build output
dist/
# generated types
.astro/

# dependencies
node_modules/

# logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*

# environment variables
.env
.env.production

# macOS-specific files
.DS_Store
55 changes: 55 additions & 0 deletions apps/docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# 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)
[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/withastro/starlight&create_from_path=examples/basics)
[![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&project-name=my-starlight-docs&repository-name=my-starlight-docs)

> 🧑‍🚀 **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).
24 changes: 0 additions & 24 deletions apps/docs/api-reference/auth.mdx

This file was deleted.

4 changes: 0 additions & 4 deletions apps/docs/api-reference/check/http/post-http.mdx

This file was deleted.

14 changes: 0 additions & 14 deletions apps/docs/api-reference/errors/code/BAD_REQUEST.mdx

This file was deleted.

14 changes: 0 additions & 14 deletions apps/docs/api-reference/errors/code/CONFLICT.mdx

This file was deleted.

14 changes: 0 additions & 14 deletions apps/docs/api-reference/errors/code/FORBIDDEN.mdx

This file was deleted.

14 changes: 0 additions & 14 deletions apps/docs/api-reference/errors/code/INTERNAL_SERVER_ERROR.mdx

This file was deleted.

14 changes: 0 additions & 14 deletions apps/docs/api-reference/errors/code/NOT_FOUND.mdx

This file was deleted.

14 changes: 0 additions & 14 deletions apps/docs/api-reference/errors/code/UNAUTHORIZED.mdx

This file was deleted.

6 changes: 0 additions & 6 deletions apps/docs/api-reference/incident/get-incident-id.mdx

This file was deleted.

6 changes: 0 additions & 6 deletions apps/docs/api-reference/incident/get-incident.mdx

This file was deleted.

7 changes: 0 additions & 7 deletions apps/docs/api-reference/incident/put-incident-id.mdx

This file was deleted.

4 changes: 0 additions & 4 deletions apps/docs/api-reference/monitor/delete-monitor-id.mdx

This file was deleted.

4 changes: 0 additions & 4 deletions apps/docs/api-reference/monitor/get-monitor-id.mdx

This file was deleted.

4 changes: 0 additions & 4 deletions apps/docs/api-reference/monitor/get-monitor-id/summary.mdx

This file was deleted.

6 changes: 0 additions & 6 deletions apps/docs/api-reference/monitor/get-monitor.mdx

This file was deleted.

4 changes: 0 additions & 4 deletions apps/docs/api-reference/monitor/post-monitor.mdx

This file was deleted.

4 changes: 0 additions & 4 deletions apps/docs/api-reference/monitor/put-monitor-id.mdx

This file was deleted.

4 changes: 0 additions & 4 deletions apps/docs/api-reference/notification/get-notification-id.mdx

This file was deleted.

4 changes: 0 additions & 4 deletions apps/docs/api-reference/notification/get-notification.mdx

This file was deleted.

4 changes: 0 additions & 4 deletions apps/docs/api-reference/notification/post-notification.mdx

This file was deleted.

6 changes: 0 additions & 6 deletions apps/docs/api-reference/page/get-page-id.mdx

This file was deleted.

4 changes: 0 additions & 4 deletions apps/docs/api-reference/page/get-page.mdx

This file was deleted.

4 changes: 0 additions & 4 deletions apps/docs/api-reference/page/post-page-id/update.mdx

This file was deleted.

4 changes: 0 additions & 4 deletions apps/docs/api-reference/page/post-page.mdx

This file was deleted.

4 changes: 0 additions & 4 deletions apps/docs/api-reference/page/put-page-id.mdx

This file was deleted.

This file was deleted.

This file was deleted.

4 changes: 0 additions & 4 deletions apps/docs/api-reference/status_report/get-status_report.mdx

This file was deleted.

This file was deleted.

4 changes: 0 additions & 4 deletions apps/docs/api-reference/status_report/post-status_report.mdx

This file was deleted.

This file was deleted.

This file was deleted.

4 changes: 0 additions & 4 deletions apps/docs/api-reference/whoami/get-whoami.mdx

This file was deleted.

Loading
Loading