Files
Modrinth-plus/docs/routes/index.md

26 lines
988 B
Markdown
Raw Normal View History

---
title: Introduction
---
2022-03-09 23:17:28 -08:00
2022-06-25 12:32:03 -07:00
## Overview
2022-03-09 22:18:22 -08:00
2022-06-25 12:32:03 -07:00
Omorphia is Modrinth's component, style, and utility library for Svelte projects. It includes:
2022-03-10 00:08:59 -08:00
2022-06-25 12:32:03 -07:00
- 🧩 Typed components which enhance HTML elements and provide a consistent UI
- 🎨 CSS classes to easily style elements with a coherent style
- 🧰 Typed utilities to solve common tasks quick and dependably
- ⚙️ Configuration for SvelteKit and PostCSS to simplify setups
- 🚚 A Rollup plugin to generate a cache of heavily used API requests and OpenAPI types
2022-03-10 00:08:59 -08:00
2022-06-25 12:32:03 -07:00
Omorphia is used in [Knossos](https://github.com/modrinth/knossos) (modrinth.com) and [Theseus](https://github.com/modrinth/theseus) (Minecraft launcher).
2022-03-10 00:08:59 -08:00
2022-06-25 12:32:03 -07:00
It uses [Svelte](https://svelte.dev/) to deliver the best performance with the least boilerplate.
2022-03-10 00:08:59 -08:00
2022-06-25 13:08:20 -07:00
## Try Omorphia online
You can try Omorphia online via [➜ **CodeSandbox** 💻](https://codesandbox.io/s/omorphia-starter-bsbgke).
2022-06-25 12:32:03 -07:00
## Getting started
2022-03-10 00:08:59 -08:00
2022-06-25 13:08:20 -07:00
Follow the instructions on the [➜ **setup page** 🛠️](/setup).