https://github.com/vortex-linux/website
This repo contains the code of the website of Vortex Linux
https://github.com/vortex-linux/website
community documentation hacktoberfest linux web-app website
Last synced: 3 months ago
JSON representation
This repo contains the code of the website of Vortex Linux
- Host: GitHub
- URL: https://github.com/vortex-linux/website
- Owner: Vortex-Linux
- License: agpl-3.0
- Created: 2024-08-14T18:09:26.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2024-12-07T05:16:55.000Z (7 months ago)
- Last Synced: 2025-04-09T22:08:58.021Z (3 months ago)
- Topics: community, documentation, hacktoberfest, linux, web-app, website
- Language: Astro
- Homepage: https://vortexlinux.org
- Size: 7.7 MB
- Stars: 1
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Vortex Linux Website
This repo contains the code of the website of Vortexlinux, it is build with HTML, CSS, JavaScript (Astro.js) and Markdown.
## 🧞 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 |
## Features:
- ✅ Minimal styling (make it your own!)
- ✅ 100/100 Lighthouse performance
- ✅ SEO-friendly with canonical URLs and OpenGraph data
- ✅ Sitemap support
- ✅ RSS Feed support
- ✅ Markdown & MDX support
## 🚀 Project Structure
You'll see the following folders and files:
```text
├── public/
├── src/
│  ├── components/
│  ├── content/
│  ├── layouts/
│  └── pages/
├── astro.config.mjs
├── README.md
├── package.json
└── tsconfig.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.
The `src/content/` directory contains "collections" of related Markdown and MDX documents. Use `getCollection()` to retrieve posts from `src/content/blog/`, and type-check your frontmatter using an optional schema. See [Astro's Content Collections docs](https://docs.astro.build/en/guides/content-collections/) to learn more.
Any static assets, like images, can be placed in the `public/` directory.
### GitHub Pages
The website is built with Astro.js on GitHub Pages, a review will be required to make any changes to the website of contributions to ensure stability of the website and ensure there aren't any unecessary build minutes used.
## 👀 Want to learn more?
Check out [Astro's documentation](https://docs.astro.build) or jump into Astro's [Discord server](https://astro.build/chat).
## Credit
This theme is based off of the lovely [Bear Blog](https://github.com/HermanMartinus/bearblog/).