Code Monkey home page Code Monkey logo

astro-to-the-moon's Introduction

Welcome to Astro

Project Notes

I have followed the Ben Holmes and whitep4nth3r session on Astro on her Youtube channel. And here is the Github repo of the project used in this video.

**Tip: ** find nice projects on astro.new.

Tip for PNPM users

Add .npmrc if using pnpm with the following content:

// expose Astro dependencies for 'pnpm' users
shamefully-hoist=true

Add Github GH CLI

Astro calls integrations what most other componies call plugins.

Add Github gh CLI:

brew install gh
gh auth login
# make the initial commit and then create and add the remote
gh repo create

Add Netlify CLI with an Alias

First, install Netlify CLI:

pnpm i -g netlify-cli
netlify --version

Now open the ~/.zshrc with nano and add the ntl alias

alias ntl='netlify'

Authorize with Github and create a new Netlify website:

ntl login # if expired run "ntl logout" first
ntl init # follow the dialog
git push
ntl open

Fetching Remote Data

Next step, let us try and fetch some Markdown file from Github and show it on the page. We create a src/components/Readme.astro file and add this code:

---
import { marked } from 'marked'
const response = await fetch('https://raw.githubusercontent.com/madrus/mdocs/master/README.md')
const markdown = await response.text()
const content = marked.parse(markdown)
---
<section set:html={content}></section>

Several notes:

  1. we have to add marked as a dependency and @types/marked as a devDependency for this to work
  2. as marked.parse() generates HTML, we need to add it via set:html={} attribute

Another Way to Deploy to Netlify

Install the @astrojs/netlify devDependency.

Live Official Examples

Open in StackBlitz

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

basics

๐Ÿš€ Project Structure

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

/
โ”œโ”€โ”€ public/
โ”‚   โ””โ”€โ”€ favicon.svg
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ components/
โ”‚   โ”‚   โ””โ”€โ”€ Card.astro
โ”‚   โ”œโ”€โ”€ layouts/
โ”‚   โ”‚   โ””โ”€โ”€ Layout.astro
โ”‚   โ””โ”€โ”€ pages/
โ”‚       โ””โ”€โ”€ index.astro
โ””โ”€โ”€ 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.

There's nothing special about src/components/, but that's where we like to put any Astro/React/Vue/Svelte/Preact 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
npm install Installs dependencies
npm run dev Starts local dev server at localhost:3000
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 preview
npm run astro --help Get help using the Astro CLI

๐Ÿ‘€ Want to learn more?

Feel free to check our documentation or jump into our Discord server.

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.