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
Inside of your Astro project, you'll see the following folders and files:
├── 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 to learn more.
Any static assets, like images, can be placed in the public/
directory.
Check out our documentation or jump into our Discord server.
- Astro
- Svelte
- Tailwind
- Less
- Storybook (if it works with astro)
- Apitable
- Weblate
With focus on:
- SEO
- (DSGVO) Privacy
- Analytics
- Multiple Storefronts
Optional:
- tailwind-config-viewer
This "Framework" is in reality just a collection of the best tools and tech i found over the years.
However, everything has been carefully selected so that in the end you can "easily" create a medium to large website.
Command | Action |
---|---|
yarn |
Installs dependencies |
yarn dev |
Starts local dev server at localhost:3000 |
yarn build |
Build your production site to ./dist/ |
yarn preview |
Preview your build locally, before deploying |
yarn astro ... |
Run CLI commands like astro add , astro check |
yarn astro --help |
Get help using the Astro CLI |
Construct of a commit message:
prefix(scope): commit subject with max 50 chars
Example commit message:
feat(comp): add ping slash command
Project specific scopes and what to use them for.
'deps', // Changes done on anything dependency related
'devops', // Changes done on technical processes
'feat', // Some new feature that has been added
'fix', // Some fixes to an existing feature
'build', // Some change on how the project is built
'chore', // Some change that just has to be done (like updating dependencies)
'ci', // Some changes to the continues integration workflows
'docs', // Some changes to documentation located in the repo (either markdown files or code DocBlocks)
'perf', // Some performance improvements
'refactor', // Some code changes, that neither adds functionality or fixes a bug
'revert', // Some changes that revert already done changes
'style', // Some fixes regarding code style
'test', // Some automated tests that have been added
Branch | Usage |
---|---|
main | The default branch |
feature/* | For developing features |
fix/* | For fixing bugs |
License - Contributing - Code of conduct - Issues - Pull requests