Add basic astro site

This commit is contained in:
Brad Treloar 2025-11-01 00:00:41 +10:30
parent 049e68843b
commit 02babbe60b
16 changed files with 5092 additions and 0 deletions

24
astro/.gitignore vendored Normal file
View file

@ -0,0 +1,24 @@
# 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
# jetbrains setting folder
.idea/

4
astro/.vscode/extensions.json vendored Normal file
View file

@ -0,0 +1,4 @@
{
"recommendations": ["astro-build.astro-vscode"],
"unwantedRecommendations": []
}

11
astro/.vscode/launch.json vendored Normal file
View file

@ -0,0 +1,11 @@
{
"version": "0.2.0",
"configurations": [
{
"command": "./node_modules/.bin/astro dev",
"name": "Development server",
"request": "launch",
"type": "node-terminal"
}
]
}

43
astro/README.md Normal file
View file

@ -0,0 +1,43 @@
# Astro Starter Kit: Minimal
```sh
npm create astro@latest -- --template minimal
```
> 🧑‍🚀 **Seasoned astronaut?** Delete this file. Have fun!
## 🚀 Project Structure
Inside of your Astro project, you'll see the following folders and files:
```text
/
├── public/
├── src/
│ └── pages/
│ └── index.astro
└── package.json
```
Astro looks for `.astro` or `.md` files in the `src/pages/` directory. Each page is exposed as a route based on its file name.
There's nothing special about `src/components/`, but that's where we like to put any Astro/React/Vue/Svelte/Preact components.
Any static assets, like images, 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?
Feel free to check [our documentation](https://docs.astro.build) or jump into our [Discord server](https://astro.build/chat).

17
astro/astro.config.mjs Normal file
View file

@ -0,0 +1,17 @@
// @ts-check
import { defineConfig } from "astro/config";
const setLayout = () => {
return function (_, file) {
if (file.data.astro.frontmatter.layout === undefined) {
file.data.astro.frontmatter.layout = "@layouts/BaseLayout.astro";
}
};
};
// https://astro.build/config
export default defineConfig({
markdown: {
remarkPlugins: [setLayout],
},
});

4840
astro/package-lock.json generated Normal file

File diff suppressed because it is too large Load diff

14
astro/package.json Normal file
View file

@ -0,0 +1,14 @@
{
"name": "astro",
"type": "module",
"version": "0.0.1",
"scripts": {
"dev": "astro dev",
"build": "astro build",
"preview": "astro preview",
"astro": "astro"
},
"dependencies": {
"astro": "^5.15.2"
}
}

9
astro/public/favicon.svg Normal file
View file

@ -0,0 +1,9 @@
<svg xmlns="http://www.w3.org/2000/svg" fill="none" viewBox="0 0 128 128">
<path d="M50.4 78.5a75.1 75.1 0 0 0-28.5 6.9l24.2-65.7c.7-2 1.9-3.2 3.4-3.2h29c1.5 0 2.7 1.2 3.4 3.2l24.2 65.7s-11.6-7-28.5-7L67 45.5c-.4-1.7-1.6-2.8-2.9-2.8-1.3 0-2.5 1.1-2.9 2.7L50.4 78.5Zm-1.1 28.2Zm-4.2-20.2c-2 6.6-.6 15.8 4.2 20.2a17.5 17.5 0 0 1 .2-.7 5.5 5.5 0 0 1 5.7-4.5c2.8.1 4.3 1.5 4.7 4.7.2 1.1.2 2.3.2 3.5v.4c0 2.7.7 5.2 2.2 7.4a13 13 0 0 0 5.7 4.9v-.3l-.2-.3c-1.8-5.6-.5-9.5 4.4-12.8l1.5-1a73 73 0 0 0 3.2-2.2 16 16 0 0 0 6.8-11.4c.3-2 .1-4-.6-6l-.8.6-1.6 1a37 37 0 0 1-22.4 2.7c-5-.7-9.7-2-13.2-6.2Z" />
<style>
path { fill: #000; }
@media (prefers-color-scheme: dark) {
path { fill: #FFF; }
}
</style>
</svg>

After

Width:  |  Height:  |  Size: 749 B

View file

@ -0,0 +1,18 @@
---
import { getDocumentPath, getDocumentTitle, getChildDocuments } from "@utils/docs";
const { document } = Astro.props;
const childDocuments = await getChildDocuments(document);
---
<ul>
{childDocuments.map(document => {
const title = getDocumentTitle(document);
const path = getDocumentPath(document);
return (
<li>
<a href={path}>{title}</a>
</li>
);
})}
</ul>

View file

@ -0,0 +1,9 @@
import { defineCollection } from "astro:content";
import { glob } from "astro/loaders";
const docs = defineCollection({
loader: glob({ pattern: "**/*.md", base: "../docs" }),
});
export const collections = { docs };

View file

@ -0,0 +1,15 @@
---
const { pageTitle } = Astro.props;
---
<html lang="en">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width" />
<title>{pageTitle}</title>
</head>
<body>
<main>
<slot />
</main>
</body>
</html>

View file

@ -0,0 +1,12 @@
---
import BaseLayout from "@layouts/BaseLayout.astro";
import DocumentMenu from "@components/DocumentMenu.astro";
import { getDocumentPath, getDocumentTitle } from "@utils/docs";
const { document } = Astro.props;
const pageTitle = getDocumentTitle(document);
---
<BaseLayout pageTitle={pageTitle}>
<slot />
<DocumentMenu document={document} />
</BaseLayout>

View file

@ -0,0 +1,22 @@
---
import { getCollection, render } from 'astro:content';
import DocumentLayout from "@layouts/DocumentLayout.astro";
import { getDocumentPath, getDocumentTitle, getChildDocuments } from "@utils/docs";
export async function getStaticPaths() {
const documents = await getCollection("docs");
return documents.map((document) => ({
params: { path: getDocumentPath(document) },
props: { document },
}));
}
const { document } = Astro.props;
const paths = await getStaticPaths();
const { Content } = await render(document);
---
<DocumentLayout document={document}>
<Content />
</DocumentLayout>

View file

@ -0,0 +1,8 @@
---
import BaseLayout from "@layouts/BaseLayout.astro";
import DocumentMenu from "@components/DocumentMenu.astro";
---
<BaseLayout pageTitle="Notes">
<h1>Notes</h1>
<DocumentMenu />
</BaseLayout>

33
astro/src/utils/docs.ts Normal file
View file

@ -0,0 +1,33 @@
import type { MarkdownHeading } from "astro";
import { getCollection, type CollectionEntry } from "astro:content";
export function getDocumentPath(document: CollectionEntry<"documents">) {
return "/" + document.id.replace(/\/_index$/, "");
}
export function getDocumentTitle(document: CollectionEntry<"documents">) {
const headings: MarkdownHeading[] =
(document.rendered?.metadata?.headings as MarkdownHeading[]) || [];
const firstHeading = headings[0];
if (firstHeading !== undefined && firstHeading.depth === 1) {
return firstHeading.text;
}
return null;
}
export async function getChildDocuments(
parentDocument: CollectionEntry<"documents"> | undefined,
) {
const documents = await getCollection("docs");
const basePath =
parentDocument !== undefined ? getDocumentPath(parentDocument) : "";
const pathPattern = new RegExp(`^${basePath}/[^/]+$`);
return documents.filter((document) => {
const documentPath = getDocumentPath(document);
return pathPattern.test(documentPath) && documentPath !== basePath;
});
}

13
astro/tsconfig.json Normal file
View file

@ -0,0 +1,13 @@
{
"extends": "astro/tsconfigs/strict",
"include": [".astro/types.d.ts", "**/*"],
"exclude": ["dist"],
"compilerOptions": {
"paths": {
"@components/*": ["src/components/*"],
"@layouts/*": ["src/layouts/*"],
"@pages/*": ["src/pages/*"],
"@utils/*": ["src/utils/*"]
}
}
}