Skip to content

Commit

Permalink
Github action
Browse files Browse the repository at this point in the history
  • Loading branch information
7rs committed Jun 9, 2024
1 parent 7770359 commit ed0f904
Show file tree
Hide file tree
Showing 52 changed files with 9,053 additions and 3,414 deletions.
3,229 changes: 0 additions & 3,229 deletions .astro/icon.d.ts

This file was deleted.

5 changes: 1 addition & 4 deletions .editorconfig
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,6 @@ insert_final_newline = true
indent_style = space
indent_size = 4

[{*.md,*.mdx}]
[{*.md,*.mdx,*.yaml}]
indent_size = 2
trim_trailing_whitespace = false

[{*.astro,*.ts,*.mjs,*.sass}]
indent_size = 2
39 changes: 39 additions & 0 deletions .github/workflows/www.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: Website

on:
push:
branches: [gh-pages]
pull_request:
branches: [gh-pages]
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4

- name: Moves directory
uses: cd www

- name: Install and Build
uses: withastro/action@v2
with:
node-version: 20

deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}

steps:
- name: Deploy to GitHub Pages
uses: actions/deploy-pages@v4
1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
git/*
dist/*
node_modules/*
2 changes: 2 additions & 0 deletions .packwizignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@
.vscode/*
dist/*
resources/*
www/*
docs/*

# Config and Settings
.editorconfig
Expand Down
19 changes: 1 addition & 18 deletions .prettierrc
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,5 @@
"singleQuote": false,
"semi": true,
"endOfLine": "lf",
"options.editorconfig": true,
"plugins": ["prettier-plugin-astro"],
"overrides": [
{
"files": ["*.ts", "*.test.ts", "*.tsx", "postcss.config.mjs"],
"options": {
"singleQuote": true,
"tabWidth": 2
}
},

{
"files": ["*.astro", "*.sass"],
"options": {
"tabWidth": 2
}
}
]
"options.editorconfig": true
}
3 changes: 3 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,9 @@
"[astro]": {
"editor.tabSize": 2
},
"[yaml]": {
"editor.tabSize": 2
},
"files.associations": {
".packwizignore": "ignore"
}
Expand Down
7 changes: 0 additions & 7 deletions astro.config.ts

This file was deleted.

5 changes: 5 additions & 0 deletions docs/.astro/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
{
"_variables": {
"lastUpdateCheck": 1717930093467
}
}
22 changes: 22 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# build output
dist/
# generated types
.astro/*
!.astro/settings.json

# 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
4 changes: 4 additions & 0 deletions docs/.vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"recommendations": ["astro-build.astro-vscode"],
"unwantedRecommendations": []
}
11 changes: 11 additions & 0 deletions docs/.vscode/launch.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
{
"version": "0.2.0",
"configurations": [
{
"command": "./node_modules/.bin/astro dev",
"name": "Development server",
"request": "launch",
"type": "node-terminal"
}
]
}
54 changes: 54 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# 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 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).
28 changes: 28 additions & 0 deletions docs/astro.config.mjs
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';

// https://astro.build/config
export default defineConfig({
server: { host: true, port: 5175 },
integrations: [
starlight({
title: 'My Docs',
social: {
github: 'https://github.com/withastro/starlight',
},
sidebar: [
{
label: 'Guides',
items: [
// Each item here is one entry in the navigation menu.
{ label: 'Example Guide', link: '/guides/example/' },
],
},
{
label: 'Reference',
autogenerate: { directory: 'reference' },
},
],
}),
],
});
Loading

0 comments on commit ed0f904

Please sign in to comment.