https://github.com/aFuzzyBear/astro-component-book

Proof of concept for a Component Editor and Documentation tool for the Astro framework
https://github.com/aFuzzyBear/astro-component-book

Last synced: 4 months ago
JSON representation

Proof of concept for a Component Editor and Documentation tool for the Astro framework

• Host: GitHub
• URL: https://github.com/aFuzzyBear/astro-component-book
• Owner: aFuzzyBear
• Created: 2021-09-07T18:43:52.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2022-02-03T19:29:47.000Z (about 3 years ago)
• Last Synced: 2024-10-28T17:36:22.494Z (4 months ago)
• Language: Astro
• Size: 111 KB
• Stars: 24
• Watchers: 6
• Forks: 2
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# [Astro](https://astro.build) Component Book

Project Lead : [jonathantneal](https://github.com/jonathantneal)

## 🧠 Overview

The purpose of this project is to create a Component Explorer and Documentation facility to work with and alongside the Astro framework.

Taking inspiration from [Storybook.js](https://github.com/storybookjs/storybook), a powerful and fully composite system that provides developers with means to create *Stories* for each component that makes up the UI for that particular application.

For this project we wish to create a similar facility to help developers utilising Astro, to create a powerful Component driven narrative. 

Using Astro's unique ability to render content statically, and components from a whole host of UI frameworks. We see the need that soon within the Astro ecosystem, developers would be wanting a similar experience that is offered by Storybook.

An editor and documentation tool that would help enforce the design principles and systems for their application. Helping them to craft and create their components.

## 🧞 Commands

All commands are run from the root of the project, from a terminal:

| Command         | Action                                          |

|:----------------|:------------------------------------------------|

| `npm install`   | Installs dependencies                           |

| `npm run start` | Serves the development site at `localhost:3000` |

| `npm run build` | Builds the production site to `./dist/`         |

| `npm run serve` | Serves the production site at `localhost:3000`  |