https://github.com/ahansson/hgrid-css-astro
Astro demo project with hgrid-css
https://github.com/ahansson/hgrid-css-astro
hgrid-css
Last synced: 4 months ago
JSON representation
Astro demo project with hgrid-css
- Host: GitHub
- URL: https://github.com/ahansson/hgrid-css-astro
- Owner: ahansson
- Created: 2021-07-19T07:47:25.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-03-06T06:22:25.000Z (about 3 years ago)
- Last Synced: 2025-08-30T07:22:29.206Z (9 months ago)
- Topics: hgrid-css
- Language: Astro
- Homepage:
- Size: 2.7 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Integrating [hgrid-css](https://github.com/ahansson/hgrid-css) in an [Astro](https://astro.build) project
## 📄 Hgrid Documentation
[https://hgrid.io/documentation/integrate/#astro](https://hgrid.io/documentation/integrate/#astro)
## 🚀 Project Structure
Inside of your Astro project, you'll see the following folders and files:
```
/
├── public/
│ ├── robots.txt
│ └── favicon.ico
├── src/
│ ├── components/
│ │ └── Tour.astro
│ └── 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.
Install `hgrid-css` as a npm package with `npm i -D hgrid-css`. Change the file ending of `global.css` to `global.scss` and initialize hgrid at the top of the file:
@use 'hgrid-css/sass/hgrid' with (
// config (see https://hgrid.io/documentation/integrate for details)
);
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 start` | Starts local dev server at `localhost:3000` |
| `npm run build` | Build your production site to `./dist/` |
## 👀 Want to learn more?
Feel free to check [our documentation](https://github.com/snowpackjs/astro) or jump into our [Discord server](https://astro.build/chat).