Code Monkey home page Code Monkey logo

astro-sarkara-starter's Introduction

Astro Sarkara Starter Kit

Astro starter based on @cieloazul310/astro-sarkara package.

npm version Netlify Status

@cieloazul310/astro-sarkara
https://github.com/cieloazul310/astro-sarkara

Astro
https://astro.build/

Panda CSS
https://panda-css.com/

Demo

GitHub Pages
https://cieloazul310.github.io/astro-sarkara-starter

Netlify
https://astro-sarkara-starter.netlify.app

Getting started

npm create astro@latest -- --template cieloazul310/astro-sarkara-starter

Getting Started
https://docs.astro.build/en/getting-started/

๐Ÿš€ Project Structure

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

/
โ”œโ”€โ”€ public/
โ”œโ”€โ”€ src/
โ”‚   โ”œโ”€โ”€ components/
โ”‚   โ”œโ”€โ”€ content
โ”‚   โ”‚   โ”œโ”€โ”€ posts/ <= Markdown / MDX contents
โ”‚   โ”‚   โ””โ”€โ”€ config.ts
โ”‚   โ”œโ”€โ”€ data/
โ”‚   โ”‚   โ””โ”€โ”€ index.ts
โ”‚   โ”œโ”€โ”€ layout/
โ”‚   โ”‚   โ””โ”€โ”€ markdown.astro
โ”‚   โ”œโ”€โ”€ pages/
โ”‚   โ”‚   โ”œโ”€โ”€ posts/
โ”‚   โ”‚   โ”‚   โ”œโ”€โ”€ [...page].astro <= for post list pages
โ”‚   โ”‚   โ”‚   โ””โ”€โ”€ [...slug].astro <= for each `.md/.mdx` page
โ”‚   โ”‚   โ””โ”€โ”€ index.mdx
โ”‚   โ””โ”€โ”€ utils/
โ””โ”€โ”€ 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: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

Configure

panda.config.ts

import {
  defineSarkaraConfig,
} from "@cieloazul310/astro-sarkara/preset";

// https://panda-css.com/docs/references/config
export default defineSarkaraConfig({
  // primary and secondary colors is required
  // https://panda-css.com/docs/customization/theme#colors
  palette: { primary: "indigo", secondary: "amber" },

  // Where to look for your css declarations
  include: ["./src/**/*.{js,ts,astro,mdx}"],

  // customizing theme
  theme: {
    extend: {

    },
  },
});

Deploy configure

GitHub Pages

  1. Settings > Code and automation > Actions > General
    Workflow permissions: Read and write permissions
  2. Settings > Code and automation > Pages
    Build and deployment Source: GitHub Actions

Netlify

  1. Site configuration > Build & Deploy > Continuous deployment
    Build settings Build command:
    npm run build -- --site $URL

Astro Sarkara Tutorial

https://cieloazul310.github.io/astro-sarkara/tutorial

astro-sarkara-starter's People

Contributors

cieloazul310 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.