https://github.com/wikibonsai/astro-bloomz

A starter project for a WikiBonsai digital garden using the Astro static site generator.
https://github.com/wikibonsai/astro-bloomz

astro bidirectional-link internal-link semantic-tree wikibonsai wikilink wikiref

Last synced: 9 months ago
JSON representation

A starter project for a WikiBonsai digital garden using the Astro static site generator.

• Host: GitHub
• URL: https://github.com/wikibonsai/astro-bloomz
• Owner: wikibonsai
• Created: 2023-03-02T16:52:49.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-09-13T21:23:51.000Z (almost 2 years ago)
• Last Synced: 2025-04-03T15:44:12.399Z (about 1 year ago)
• Topics: astro, bidirectional-link, internal-link, semantic-tree, wikibonsai, wikilink, wikiref
• Language: Astro
• Homepage: https://astro-bloomz.netlify.app/
• Size: 1.36 MB
• Stars: 5
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Astro-Bloomz

[![A WikiBonsai Project](https://img.shields.io/badge/%F0%9F%8E%8B-A%20WikiBonsai%20Project-brightgreen)](https://github.com/wikibonsai/wikibonsai)



  

  



An [Astro template](https://github.com/withastro/astro/tree/main/examples/blog) with [WikiBonsai](https://github.com/wikibonsai/wikibonsai) support.

You can see the live demo [here](https://astro-bloomz.netlify.app/).

🌸 Share bloomz from your [🎋 WikiBonsai](https://github.com/wikibonsai/wikibonsai) digital garden.

## Getting Started

### 1. Clone this Repository

```

git clone https://github.com/wikibonsai/astro-bloomz.git my-blog-name

```

### 2. Navigate to the directory

```

cd my-blog-name

```

### 3. Install dependencies

```

npm install

```

### 4. Run

```

npm run dev

```

## 🪴 Project Structure

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

```text

├── 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](https://docs.astro.build/en/guides/content-collections/) to learn more.

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                     |

## 👀 Want to learn more?

Check out the [Astro documentation](https://docs.astro.build) or [WikiBonsai documentation](https://github.com/wikibonsai/wikibonsai/).