From 38cb5702e3ea3f34c107d15e8a48a22b90d14154 Mon Sep 17 00:00:00 2001 From: Christian Beutel <> Date: Sun, 5 Jan 2025 13:43:43 +0100 Subject: [PATCH] makes version dynamic --- docs/README.md | 55 ------------------- docs/src/content.config.ts | 7 +++ docs/src/content/config.ts | 6 -- .../{Installation.md => installation.mdx} | 3 +- 4 files changed, 9 insertions(+), 62 deletions(-) delete mode 100644 docs/README.md create mode 100644 docs/src/content.config.ts delete mode 100644 docs/src/content/config.ts rename docs/src/content/docs/getting-started/{Installation.md => installation.mdx} (97%) diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 43ad3998..00000000 --- a/docs/README.md +++ /dev/null @@ -1,55 +0,0 @@ -# Starlight Starter Kit: Tailwind - -[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build) - -``` -npm create astro@latest -- --template starlight/tailwind -``` - -[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/withastro/starlight/tree/main/examples/tailwind) -[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/withastro/starlight/tree/main/examples/tailwind) -[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2Fwithastro%2Fstarlight%2Ftree%2Fmain%2Fexamples%2Ftailwind&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 -β”œβ”€β”€ tailwind.config.mjs -└── 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). diff --git a/docs/src/content.config.ts b/docs/src/content.config.ts new file mode 100644 index 00000000..4613f537 --- /dev/null +++ b/docs/src/content.config.ts @@ -0,0 +1,7 @@ +import { defineCollection } from 'astro:content'; +import { docsLoader } from "@astrojs/starlight/loaders"; +import { docsSchema } from "@astrojs/starlight/schema"; + +export const collections = { + docs: defineCollection({ loader: docsLoader(), schema: docsSchema() }), +}; \ No newline at end of file diff --git a/docs/src/content/config.ts b/docs/src/content/config.ts deleted file mode 100644 index 45f60b01..00000000 --- a/docs/src/content/config.ts +++ /dev/null @@ -1,6 +0,0 @@ -import { defineCollection } from 'astro:content'; -import { docsSchema } from '@astrojs/starlight/schema'; - -export const collections = { - docs: defineCollection({ schema: docsSchema() }), -}; diff --git a/docs/src/content/docs/getting-started/Installation.md b/docs/src/content/docs/getting-started/installation.mdx similarity index 97% rename from docs/src/content/docs/getting-started/Installation.md rename to docs/src/content/docs/getting-started/installation.mdx index e0ec5731..04b59496 100644 --- a/docs/src/content/docs/getting-started/Installation.md +++ b/docs/src/content/docs/getting-started/installation.mdx @@ -2,6 +2,7 @@ title: Installation description: Detailed installation instructions for docker and bare-metal --- +import { version } from '../../../../package.json'; wanderer consists of three components: 1. the frontend written with [SvelteKit](https://github.com/sveltejs/kit) @@ -115,7 +116,7 @@ To update all containers to a new version simply run `docker compose pull && doc While not recommended it is absolutely possible to install wanderer from source. ### Prerequisites -1. git installed && `git clone https://github.com/Flomp/wanderer.git --branch v0.12.0 --single-branch` +1. git installed && git clone https://github.com/Flomp/wanderer.git --branch v{version} --single-branch 2. go >= 1.21.1 installed 3. node >= 18.17.0 installed 4. npm >= 8.15.0 installed