From 39abbca149c291f89cde65275464c88d4f7ee508 Mon Sep 17 00:00:00 2001 From: Christoph Haas Date: Tue, 24 Dec 2024 02:08:28 +0100 Subject: [PATCH] added link to github. simplified README. --- README.md | 107 ++--------------------------------------------- astro.config.mjs | 3 ++ 2 files changed, 7 insertions(+), 103 deletions(-) diff --git a/README.md b/README.md index 4366193..0c7cf1d 100644 --- a/README.md +++ b/README.md @@ -1,106 +1,7 @@ -# Starlight Starter Kit: Basics +# ISPmail guide -[![Built with Starlight](https://astro.badg.es/v2/built-with-starlight/tiny.svg)](https://starlight.astro.build) +This repository holds the ISPmail guide as found on workaround.org. -``` -npm create astro@latest -- --template starlight -``` +It was built using the static site generator [Starlight](https://starlight.astro.build). -[![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 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) -[![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). - -## Todo - -Offer a way to collate all pages into one for PDF/printing. - -- https://github.com/withastro/starlight/discussions/964 - -Additional links in navbar: - -- https://starlight-utils.pages.dev/utilities/nav-links/ - -Colors: - -- https://github.com/withastro/starlight/blob/a1926ce87b43aaa25b9063f9776e8e4ffabed88d/packages/starlight/style/props.css#L2 - -Quiz: - - - - -## Test your knowledge - -Which of the following is a code editor, for making changes to your files and their content? - - - - - - - -Which of the following is a code editor, for making changes to your files and their content? - - - - - - - - +More information on how to contribute will follow. diff --git a/astro.config.mjs b/astro.config.mjs index 51332de..9adb544 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -11,6 +11,9 @@ export default defineConfig({ starlight({ lastUpdated: true, title: "ISPmail Guide", + social: { + github: "https://github.com/Signum/workaround-astro-starlight", + }, // https://expressive-code.com/key-features/word-wrap/#configuration components: { Footer: "./src/components/Footer.astro",