Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/joacod/oddify
An odd looking UI component library for Astro 🚀
https://github.com/joacod/oddify
astro components-library css css3 ui-design ui-library
Last synced: 1 day ago
JSON representation
An odd looking UI component library for Astro 🚀
- Host: GitHub
- URL: https://github.com/joacod/oddify
- Owner: joacod
- License: mit
- Created: 2024-01-14T15:11:15.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-09-12T02:05:55.000Z (about 2 months ago)
- Last Synced: 2024-10-12T05:42:13.052Z (25 days ago)
- Topics: astro, components-library, css, css3, ui-design, ui-library
- Language: CSS
- Homepage:
- Size: 204 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Oddify
[![GitHub](https://img.shields.io/github/license/mashape/apistatus.svg)](https://github.com/joacod/oddify/blob/main/LICENSE)
[![NPM](https://img.shields.io/badge/NPM-%23CB3837.svg?style=for-the-badge&logo=npm&logoColor=white)](https://www.npmjs.com/package/oddify)
[![Astro](https://img.shields.io/badge/astro-%232C2052.svg?style=for-the-badge&logo=astro&logoColor=white)](https://astro.build/)## 👋 Introduction
An odd looking UI component library for [Astro](https://astro.build/) 🚀
## 📚 Documentation
To run the documentation and see all available components, you can run the following commands.
```bash
cd docs
pnpm i
pnpm run dev
```## 💻 Development
**Install library:**
```bash
npm i oddify
```**Configure tsconfig.json in your project:**
```json
{
"compilerOptions": {
"baseUrl": ".",
"paths": {
"@oddify": ["../lib.astro"]
}
}
}
```**Use component example:**
```bash
---
import {Button} from "@oddify";
---Click Me
```## ☕️ Did you like the project?
You can colaborate with me giving a star ⭐️ to the project or
[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/joacod)
Thanks! 😃