Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/starhearthunt/blog
A blog of mine built on Astro and TailwindCSS
https://github.com/starhearthunt/blog
astro blog markdown mdx
Last synced: 4 months ago
JSON representation
A blog of mine built on Astro and TailwindCSS
- Host: GitHub
- URL: https://github.com/starhearthunt/blog
- Owner: StarHeartHunt
- Created: 2023-03-24T02:42:24.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-08T11:00:51.000Z (10 months ago)
- Last Synced: 2024-04-09T12:48:01.084Z (10 months ago)
- Topics: astro, blog, markdown, mdx
- Language: Astro
- Homepage: https://baka.icu
- Size: 1.1 MB
- Stars: 6
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Blog
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
```
├── 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.
## 🧞 Commands
All commands are run from the root of the project, from a terminal:
| Command | Action |
| :---------------------- | :----------------------------------------------- |
| `pnpm install` | Installs dependencies |
| `pnpm run dev` | Starts local dev server at `localhost:3000` |
| `pnpm run build` | Build your production site to `./dist/` |
| `pnpm run preview` | Preview your build locally, before deploying |
| `pnpm run astro ...` | Run CLI commands like `astro add`, `astro check` |
| `pnpm run astro --help` | Get help using the Astro CLI |