Files
AstralRinth/src/routes/index.md
2022-03-13 23:40:17 -07:00

1.2 KiB

title
title
Introduction

What is Omorphia?

Omorphia is Modrinth's style and reusable component library for use in all of its frontend applications, including knossos (modrinth.com), theseus (launcher), and planned projects such as Modrinth's in-house auth and ad-server.

It uses Svelte to deliver the best performance with the least boilerplate.

Getting started

Adding Omorphia to your project is as easy as:

pnpm add omorphia

Components

Import a component with:

import { Button } from "omorphia"

Then, use it in your HTML:

<Button color="primary">Click me!</Button>

For more information on each component, check out the pages on the sidebar navigation.

To get Svelte language support in your code editor, use this list of extensions.

Using icons and styles

Follow the guides on the sidebar to learn how to use icons and general concepts.