
# <img width="30px" src="assets/brand/AsagaoUISymbolNOMargin.svg" alt="AsagaoUISymbol"> AsagaoUI

AsagaoUI is a UI for beautiful and accessible digital services, based on Japan's [Digital Agency design system](https://design.digital.go.jp).

## ⚡ WARNING ⚡

`main` branch is for development and is not stable.

### Development Status

AsagaoUI is in the early stages of development and may be unstable.

## Quickstart

### CDN

[https://www.jsdelivr.com/package/npm/asagaoui](https://www.jsdelivr.com/package/npm/asagaoui)

### Clone repository

```bash
git clone https://github.com/ctpena/asagaoui.git
```

`dist/css/asagaoui.css` is the compiled CSS. You can use it in any way you prefer.

The compiled JavaScript is located at `dist/js/asagaoui.js`.

### Install with NPM

```bash
npm i asagaoui
```

### Minimum HTML

The following HTML is required

```html
<!doctype html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>AsagaoUI demo</title>
    <link rel="stylesheet" href="dist/css/asagaoui.css">
</head>
<body class="aui">
<h1>AsagaoUI</h1>
</body>
</html>
```

## Documentation

AsagaoUI documentation is located in the site folder of the project.
The documentation site is built with [HUGO](https://gohugo.io) and is hosted at https://asagaoui.com.

## License

AsagaoUI is licensed under the MIT License.

AsagaoUI also includes several external libraries. For all licenses, please see the NOTICE file.

The documentation located under site/content/ is licensed under the CC BY 4.0.

## Contact

If you have any questions or suggestions, please email:`aui@asagaoui.com`
