Git Product home page Git Product logo

astro-website's Introduction

Dorkodu's Astro Template

A minimalist website template with Astro.

Ideal for portfolios, blogs, landing pages or personal websites.

Used: React, TypeScript, Mantine UI, MDX, Partytown, Sitemap

๐Ÿง‘โ€๐Ÿš€ Seasoned astronaut? Delete this file. Have fun!

just-the-basics

๐Ÿš€ Project Structure

Inside of your Astro project, you'll see the following folders and files:

/
โ”œโ”€โ”€ public/
โ”‚   โ”œโ”€โ”€ images/
โ”‚   โ”‚   โ””โ”€โ”€ example.png
โ”‚   โ”œโ”€โ”€ fonts/
โ”‚   โ”‚   โ””โ”€โ”€ Font.ttf
โ”‚   โ””โ”€โ”€ favicon.svg
โ”‚   โ””โ”€โ”€ robots.txt
โ”‚   โ””โ”€โ”€ site.webmanifest
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ components/
โ”‚   โ”‚   โ””โ”€โ”€ Header.astro
โ”‚   โ”‚   โ””โ”€โ”€ Footer.astro
โ”‚   โ”‚   โ””โ”€โ”€ Hero.astro
โ”‚   โ”‚   โ””โ”€โ”€ Card.astro
โ”‚   โ”œโ”€โ”€ layouts/
โ”‚   โ”‚   โ””โ”€โ”€ Layout.astro
โ”‚   โ”œโ”€โ”€ styles/
โ”‚   โ”‚   โ””โ”€โ”€ theme.ts
โ”‚   โ”‚   โ””โ”€โ”€ index.css
โ”‚   โ”‚   โ””โ”€โ”€ index.css.ts
โ”‚   โ”‚   โ””โ”€โ”€ Layout.css.ts
โ”‚   โ”œโ”€โ”€ pages/
โ”‚   โ”‚    โ””โ”€โ”€ index.astro
โ”‚   โ”‚    โ””โ”€โ”€ about.astro
โ”‚   โ”œโ”€โ”€ env.d.ts
โ”‚   โ”œโ”€โ”€ postcss.config.js
โ”‚   โ”œโ”€โ”€ site.config.ts
โ”‚   โ””โ”€โ”€
โ””โ”€โ”€ 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.

Nothing special about src/components/, just where we like to put our 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
pnpm install Installs dependencies
pnpm dev Starts local dev server at localhost:4321
pnpm build Build your production site to ./dist/
pnpm preview Preview your build locally, before deploying
pnpm astro ... Run CLI commands like astro add, astro check
pnpm astro -- --help Get help using the Astro CLI

๐Ÿ‘€ Want to learn more?

Feel free to check Astro's documentation.

astro-website's People

Contributors

dorukeray avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.