Files
AstralRinth/src/routes/index.md
2022-03-10 00:08:59 -08:00

1.2 KiB

svelte:head </svelte:head>

Introduction

Kleos is in early development, and not ready for use in any application. Contribute to it on GitHub.

What is Kleos?

Kleos 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 Kleos to your project is as easy as:

pnpm add kleos

Components

Import a component with:

import { Button } from "kleos"

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.

Icons, Styles, and more

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