loftwah/linux-for-pirates
A book we're writing about Linux, in the theme of Pirates!
Linux for Pirates - Astro Website
This is an Astro-powered website for the "Linux for Pirates" guide, featuring Tailwind CSS 4 and dark mode support.
Features
- Built with Astro 5.5+
- Styled with Tailwind CSS 4
- Dark/Light mode toggle that respects user preferences
- Responsive design optimized for all devices
- Optimized for GitHub Pages deployment
Development
Prerequisites
- Node.js 18+
- npm or pnpm
Setup
# Install dependencies
npm install
# Start dev server
npm run devBuild
# Build for production
npm run build
# Preview the build
npm run previewDeployment
This site is configured to deploy to GitHub Pages using GitHub Actions. When you push to the main branch, it will automatically build and deploy your site.
Technology Stack
License
Same as the original Linux for Pirates repository.
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:
/
โโโ 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 or jump into our Discord server.