Skip to content

Commit ec5de9b

Browse files
doc: new site
1 parent c7f4ab9 commit ec5de9b

36 files changed

+10011
-0
lines changed

www/.gitignore

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# build output
2+
dist/
3+
# generated types
4+
.astro/
5+
6+
# dependencies
7+
node_modules/
8+
9+
# logs
10+
npm-debug.log*
11+
yarn-debug.log*
12+
yarn-error.log*
13+
pnpm-debug.log*
14+
15+
16+
# environment variables
17+
.env
18+
.env.production
19+
20+
# macOS-specific files
21+
.DS_Store

www/.vscode/extensions.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"recommendations": ["astro-build.astro-vscode"],
3+
"unwantedRecommendations": []
4+
}

www/.vscode/launch.json

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
{
2+
"version": "0.2.0",
3+
"configurations": [
4+
{
5+
"command": "./node_modules/.bin/astro dev",
6+
"name": "Development server",
7+
"request": "launch",
8+
"type": "node-terminal"
9+
}
10+
]
11+
}

www/README.md

Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
# Starlight Starter Kit: Basics
2+
3+
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
4+
5+
```
6+
npm create astro@latest -- --template starlight
7+
```
8+
9+
[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/basics)
10+
[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/basics)
11+
[![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)
12+
[![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)
13+
14+
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
15+
16+
## 🚀 Project Structure
17+
18+
Inside of your Astro + Starlight project, you'll see the following folders and files:
19+
20+
```
21+
.
22+
├── public/
23+
├── src/
24+
│ ├── assets/
25+
│ ├── content/
26+
│ │ ├── docs/
27+
│ │ └── config.ts
28+
│ └── env.d.ts
29+
├── astro.config.mjs
30+
├── package.json
31+
└── tsconfig.json
32+
```
33+
34+
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.
35+
36+
Images can be added to `src/assets/` and embedded in Markdown with a relative link.
37+
38+
Static assets, like favicons, can be placed in the `public/` directory.
39+
40+
## 🧞 Commands
41+
42+
All commands are run from the root of the project, from a terminal:
43+
44+
| Command | Action |
45+
| :------------------------ | :----------------------------------------------- |
46+
| `npm install` | Installs dependencies |
47+
| `npm run dev` | Starts local dev server at `localhost:4321` |
48+
| `npm run build` | Build your production site to `./dist/` |
49+
| `npm run preview` | Preview your build locally, before deploying |
50+
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
51+
| `npm run astro -- --help` | Get help using the Astro CLI |
52+
53+
## 👀 Want to learn more?
54+
55+
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).

www/astro.config.mjs

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,59 @@
1+
// @ts-check
2+
import { defineConfig } from 'astro/config';
3+
import starlight from '@astrojs/starlight';
4+
import starlightLinksValidator from 'starlight-links-validator'
5+
import tailwind from '@astrojs/tailwind';
6+
7+
// https://astro.build/config
8+
export default defineConfig({
9+
site: 'https://opensource.axo.dev/dist',
10+
integrations: [starlight({
11+
title: 'dist',
12+
logo: {
13+
light: './src/assets/package-light.svg',
14+
dark: './src/assets/package-dark.svg',
15+
},
16+
plugins: [starlightLinksValidator()],
17+
customCss: ['./src/styles/custom.css', './src/styles/fonts.css', './src/styles/tailwind.css'],
18+
favicon: 'public/favicon.svg',
19+
head: [
20+
// Add ICO favicon fallback for Safari.
21+
{
22+
tag: 'link',
23+
attrs: {
24+
rel: 'icon',
25+
href: '/public/favicon.ico',
26+
sizes: '32x32',
27+
},
28+
},
29+
],
30+
social: {
31+
github: 'https://github.com/axodotdev/cargo-dist',
32+
twitter: 'https://twitter.com/axodotdev',
33+
mastodon: 'https://mastodon.social/axodotdev',
34+
},
35+
components: {
36+
// Override the default `SocialIcons` component.
37+
SocialIcons: './src/components/overrides/SocialIcons.astro',
38+
},
39+
sidebar: [
40+
{
41+
label: 'Start here',
42+
items: [
43+
{ label: 'Installation', slug: 'start/install' },
44+
{ label: 'Updating', slug: 'start/update' },
45+
{ label: 'Project structure', slug: 'start/structure' },
46+
{ label: 'Configuration', slug: 'start/config' }
47+
]
48+
},
49+
{
50+
label: 'Reference',
51+
autogenerate: { directory: 'reference' },
52+
},
53+
],
54+
}), tailwind({
55+
// Disable the default base styles:
56+
applyBaseStyles: false,
57+
})
58+
],
59+
});

0 commit comments

Comments
 (0)