initial astro env

This commit is contained in:
Ethan Holz
2023-10-25 11:21:05 -05:00
parent 771fce09f4
commit 49f052621e
7 changed files with 6975 additions and 18 deletions

1
.gitattributes vendored Normal file
View File

@@ -0,0 +1 @@
*.webp filter=lfs diff=lfs merge=lfs -text

35
.gitignore vendored
View File

@@ -1,16 +1,21 @@
Thumbs.db # 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 .DS_Store
.dist
.tmp
.lock
.sass-cache
npm-debug.log
node_modules
builds
package-lock.json
public
resources
.hugo_build.lock
jsconfig.json
hugo_stats.json
yarn.lock

45
README.md Normal file
View File

@@ -0,0 +1,45 @@
# grlx docs
[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build)
## 🚀 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 [Starlights docs](https://starlight.astro.build/), read [the Astro documentation](https://docs.astro.build), or jump into the [Astro Discord server](https://astro.build/chat).

23
astro.config.mjs Normal file
View File

@@ -0,0 +1,23 @@
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';
// https://astro.build/config
export default defineConfig({
integrations: [
starlight({
title: 'grlx.dev',
logo: { src: './src/assets/grlx.webp' },
social: {
github: 'https://gihthub.com/gogrlx/grlx',
'x.com': 'https://x.com/gogrlx',
},
sidebar: [
{label: 'Getting Started', link: '/getting-started'},
{
label: 'Ingredients',
autogenerate: { directory: 'ingredients' },
},
],
}),
],
});

6870
package-lock.json generated Normal file

File diff suppressed because it is too large Load Diff

View File

@@ -1,7 +1,17 @@
{ {
"name": "grlx-starlight",
"type": "module",
"version": "0.0.1",
"scripts": {
"dev": "astro dev",
"start": "astro dev",
"build": "astro build",
"preview": "astro preview",
"astro": "astro"
},
"dependencies": { "dependencies": {
"autoprefixer": "^10.4.16", "@astrojs/starlight": "^0.11.1",
"postcss": "^8.4.31", "astro": "^3.2.3",
"postcss-cli": "^10.1.0" "sharp": "^0.32.5"
} }
} }

3
tsconfig.json Normal file
View File

@@ -0,0 +1,3 @@
{
"extends": "astro/tsconfigs/strict"
}