https://github.com/alumnium-hq/alumnium.github.io

Alumnium website
https://github.com/alumnium-hq/alumnium.github.io

Last synced: 24 days ago
JSON representation

Alumnium website

• Host: GitHub
• URL: https://github.com/alumnium-hq/alumnium.github.io
• Owner: alumnium-hq
• Created: 2024-10-28T14:52:56.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-24T06:32:11.000Z (about 1 month ago)
• Last Synced: 2024-11-24T07:25:59.576Z (about 1 month ago)
• Language: JavaScript
• Homepage: https://alumnium.ai/
• Size: 5.96 MB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Alumnium website

## 🚀 Project Structure

Inside 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                                           |

| :------------------------- | :----------------------------------------------- |

| `yarn install`             | Installs dependencies                            |

| `yarn run dev`             | Starts local dev server at `localhost:4321`      |

| `yarn run build`           | Build your production site to `./dist/`          |

| `yarn run preview`         | Preview your build locally, before deploying     |

| `yarn run astro ...`       | Run CLI commands like `astro add`, `astro check` |

| `yarn run astro -- --help` | Get help using the Astro CLI                     |