https://github.com/erkobridee/astro-starlight-hello
Testing the Astro Starlight
https://github.com/erkobridee/astro-starlight-hello
astro blog devcontainer docker docs i18n starlight svelte tailwind types
Last synced: 2 months ago
JSON representation
Testing the Astro Starlight
- Host: GitHub
- URL: https://github.com/erkobridee/astro-starlight-hello
- Owner: erkobridee
- License: mit
- Created: 2024-11-20T10:07:41.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-03-10T07:21:34.000Z (over 1 year ago)
- Last Synced: 2025-03-10T08:26:26.819Z (over 1 year ago)
- Topics: astro, blog, devcontainer, docker, docs, i18n, starlight, svelte, tailwind, types
- Language: MDX
- Homepage: https://erkobridee.github.io/astro-starlight-hello/
- Size: 2.96 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Hello Astro Starlight [](https://deepwiki.com/erkobridee/astro-starlight-hello)
[](https://starlight.astro.build)
[](https://astro.build/)
[](https://svelte.dev/)
[](https://tailwindcss.com/)
[](https://www.typescriptlang.org/)
[](https://www.docker.com/)
[](https://containers.dev/)
## Initial setup
```
npm create astro@latest -- --template starlight/tailwind
```
## 🧞 Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
| :------------------------ | :-------------------------------------------------------------------------------------- |
| `npm install` | Installs dependencies |
| `npm start` | Starts local dev server at `localhost:4321` |
| `npm run dev` | Starts local dev server at `localhost:4321` |
| `npm run sync` | Run the CLI command `astro sync` that generates TypeScript types for all Astro modules. |
| `npm run build` | Build your production site to `./dist/` |
| `npm run preview` | Preview your build locally, before deploying |
| `npm run build-n-preview` | Build the production site and run the preview |
| `npm run lint` | Run the `prettier` and `eslint` |
| `npm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `npm run astro -- --help` | Get help using the Astro CLI |
### Docker Commands
| Command | Action |
| :--------------------- | :-------------------------------------------------------------------- |
| `npm run docker:build` | `docker build --no-cache -t astro-starlight-hello .` |
| `npm run docker:check` | `docker run -it astro-starlight-hello sh` |
| `npm run docker:rmi` | `docker rmi -f astro-starlight-hello` |
| `npm run docker:run` | `docker run -p 8080:8080 astro-starlight-hello` |
| `npm run docker:rund` | `docker run --name web-preview -d -p 8080:8080 astro-starlight-hello` |
| `npm run docker:stopd` | `docker stop web-preview` |
| `npm run docker:rm` | `docker rm $(docker ps -aq --filter name=web-preview)` |
| `npm run docker:stop` | `run-s docker:stopd docker:rm` |
## Local Development
- [VS Code](https://code.visualstudio.com/) + [Development Containers](https://containers.dev/) ( [Customizations](https://containers.dev/supporting#visual-studio-code) | [VS Code Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) )
- [[GitHub] erkobridee/devcontainer-hello](https://github.com/erkobridee/devcontainer-hello) - Learning about Development Containers
## Test it online
[](https://stackblitz.com/github/erkobridee/astro-starlight-hello)
[](https://codespaces.new/erkobridee/astro-starlight-hello?devcontainer_path=.devcontainer/devcontainer.json)
## Setup a new project using this repository
You can use the `Use this template` button
### degit
```sh
npx degit erkobridee/astro-starlight-hello {project_name}
```
### create a new project based on a GitHub repository’s main branch
```sh
npm create astro@latest -- --template erkobridee/astro-starlight-hello
```
## 👀 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).
## References
- [[GitHub] trueberryless-org/awesome-starlight](https://github.com/trueberryless-org/awesome-starlight) - Awesome List of Starlight plugins, tools, content and showcase sites updated weekly with AI.
- [@astrojs/svelte | Astro Docs](https://docs.astro.build/en/guides/integrations-guide/svelte/)
- [Internationalization (i18n) | Guides - Starlight](https://starlight.astro.build/guides/i18n/)
- [Authoring Content in Markdown | Guides - Starlight](https://starlight.astro.build/guides/authoring-content/)
- [Custom 404 page - Customizing Starlight | Guides - Starlight](https://starlight.astro.build/guides/customization/#custom-404-page)
- [Custom fonts - Customizing Starlight | Guides - Starlight](https://starlight.astro.build/guides/customization/#custom-fonts)
- [Poppins | Fontsource](https://fontsource.org/fonts/poppins)
- [Poppins | Google Fonts](https://fonts.google.com/specimen/Poppins)
- [CSS & Styling | Guides - Starlight](https://starlight.astro.build/guides/css-and-tailwind/#color-theme-editor)
- Contrast level: `AAA`
- Accent [ Hue: `139`, Chroma: `0.27` ]
- Gray [ Hue: `139`, Chroma: `0.1` ]
- base color: `#1c5800`
- code logic to load the documents from `src/content/docs` : [Starlight repo - packages/starlight/utils/routing.ts](https://github.com/withastro/starlight/blob/6f3202b3eb747de8a1cfcba001ab618d5fdee44a/packages/starlight/utils/routing.ts)
### Override Starlight Components
- [Overriding Components | Guides - Starlight](https://starlight.astro.build/guides/overriding-components/)
- [Overrides Reference | Reference - Starlight](https://starlight.astro.build/reference/overrides/)
### View Transitions
- [View transitions | Guides - Astro Docs](https://docs.astro.build/en/guides/view-transitions/)
- [View Transitions Router API Reference | Runtime API - Astro Docs](https://docs.astro.build/en/reference/modules/astro-transitions/)
- [Guide: Add View Transitions to Starlight | Bag of Tricks](https://events-3bg.pages.dev/jotter/starlight/guide/)
- [[GitHub] martrapp/astro-vtbot](https://github.com/martrapp/astro-vtbot) - The 👜 Bag of Tricks ✨ for Astro's View Transitions. ⭐️ Please star to support this work!
### Examples of Customizations
- [[GitHub] kinde-oss/documentation](https://github.com/kinde-oss/documentation)
- [[GitHub] mearashadowfax/ScrewFast](https://github.com/mearashadowfax/ScrewFast) - Open-source Astro website template with sleek, customizable TailwindCSS components. [ Interesting case: site, blog and documentation ]
### Examples of Themes
- [[GitHub] HiDeoo/starlight-theme-rapide](https://github.com/HiDeoo/starlight-theme-rapide) - Starlight theme inspired by the Visual Studio Code Vitesse theme
- [[GitHub] Fevol/starlight-theme-obsidian](https://github.com/Fevol/starlight-theme-obsidian) - Starlight theme inspired by the style of Obsidian Publish sites
### Examples of Blog
- [[GitHub] HiDeoo/starlight-blog](https://github.com/HiDeoo/starlight-blog) - Starlight plugin to add a blog to your documentation
- [[GitHub] wasp-lang/open-saas/opensaas-sh/blog](https://github.com/wasp-lang/open-saas/tree/main/opensaas-sh/blog)
- [[GitHub] rebecamurillo/astro-blog-i18n-starter](https://github.com/rebecamurillo/astro-blog-i18n-starter) - Astro built starter project for a static website and blog witth multilingual i18n configuration.
### Docker
- [Build your Astro Site with Docker | Astro Docs](https://docs.astro.build/en/recipes/docker/)
- [How to deploy your Astro static site with Nginx and Docker | Michaël Gainyo](https://michaelgainyo.github.io/blog/deploy-astro-build-static-site-with-docker-nginx/)
- [How to Dockerize and Deploy Astro | DEV Community](https://dev.to/code42cate/how-to-dockerize-and-deploy-astro-6ll)