mirror of
https://ark.sudovanilla.org/Korbs/Pandora.git
synced 2024-12-22 11:03:53 +00:00
55 lines
1.5 KiB
Markdown
55 lines
1.5 KiB
Markdown
# Pandora
|
|
|
|
An Astro component library for SudoVanilla related websites and projects.
|
|
|
|
>[!WARNING]
|
|
> Pandora is in early development is not built yet to be utilized in other projects outside of SudoVanilla.
|
|
|
|
## Installation
|
|
|
|
To install Pandora for your Astro website, running the following:
|
|
```
|
|
bun install --registry https://js.registry.sudovanilla.org/
|
|
```
|
|
|
|
## Usage
|
|
|
|
You can use Pandora like with any other Astro component, import and use:
|
|
|
|
```jsx
|
|
---
|
|
import {CallToAction} from "@sudovanilla/pandora"
|
|
---
|
|
|
|
<CallToAction
|
|
Title="Section Title"
|
|
Description="Description for the section."
|
|
ImageSource="image.png"
|
|
ImageAlt="Describe the image"
|
|
PrimaryActionText="Primary Action"
|
|
PrimaryAction="https://example.com/"
|
|
/>
|
|
```
|
|
|
|
## License
|
|
|
|
```
|
|
Copyright (C) 2023 - 2025 MinPluto
|
|
|
|
This program is free software: you can redistribute it and/or modify
|
|
it under the terms of the GNU Affero General Public License as
|
|
published by the Free Software Foundation, either version 3 of the
|
|
License, or (at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU Affero General Public License for more details.
|
|
|
|
You should have received a copy of the GNU Affero General Public License
|
|
along with this program. If not, see https://www.gnu.org/licenses/.
|
|
```
|
|
|
|
___
|
|
|
|
[](https://nogithub.codeberg.page) |