Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/protomorph/astro-zero

A zero styling, simple, Astro blog starter template.
https://github.com/protomorph/astro-zero

astro astro-blog astro-starter markdown mdx ssg static-site static-site-generator typescript

Last synced: 4 months ago
JSON representation

A zero styling, simple, Astro blog starter template.

Host: GitHub
URL: https://github.com/protomorph/astro-zero
Owner: protomorph
License: mit
Created: 2024-07-15T00:42:36.000Z (7 months ago)
Default Branch: main
Last Pushed: 2024-09-30T20:13:10.000Z (4 months ago)
Last Synced: 2024-10-01T05:21:03.676Z (4 months ago)
Topics: astro, astro-blog, astro-starter, markdown, mdx, ssg, static-site, static-site-generator, typescript
Language: Astro
Homepage:
Size: 974 KB
Stars: 3
Watchers: 1
Forks: 1
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Astro Zero

A zero styling, simple, Astro blog starter template.

## Getting Started

Clone this Repository.

```sh

# with git

git clone https://github.com/protomorph/astro-zero.git

# or with GitHub CLI

gh repo clone protomorph/astro-zero

```

then run:

```sh

# install dependencies

npm install

# run dev server

npm run dev

# preview production build

npm run preview

# build production site

npm run build

```

or use one of these:

[![Open in StackBlitz](https://developer.stackblitz.com/img/open_in_stackblitz.svg)](https://stackblitz.com/github/protomorph/astro-zero)

[![Open with CodeSandbox](https://assets.codesandbox.io/github/button-edit-lime.svg)](https://codesandbox.io/p/sandbox/github/protomorph/astro-zero)

[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/protomorph/astro-zero?devcontainer_path=.devcontainer/minimal/devcontainer.json)

## Intergrations

This project comes with some intergration pre installed:

 - MDX

 - Sitemap

 - AutoImport

also includes:

 - Simple search functionallity

 - Custom markdown and component code block

 - Draft, Featured & Related blog posts

## 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                     |