An open API service indexing awesome lists of open source software.

https://github.com/graylog2/design-system

Graylog Design System Documentation
https://github.com/graylog2/design-system

Last synced: 7 days ago
JSON representation

Graylog Design System Documentation

Awesome Lists containing this project

README

          

# Graylog Design System

The Graylog Design System is a shared design language and component library for building consistent, accessible Graylog interfaces.

This repository contains only the GitHub actions deployment workflow. See the live version at [https://graylog2.github.io/design-system/](https://graylog2.github.io/design-system/).

The [source code](https://github.com/Graylog2/graylog2-server/tree/master/graylog2-web-interface/docs/graylog-luma) for the design system is part of the [graylog2-server](https://github.com/Graylog2/graylog2-server) repository.

## Run documentation locally

1. Clone [graylog2-server](https://github.com/Graylog2/graylog2-server)
2. Go to the `graylog2-web-interface` folder: `cd graylog2-web-interface`
3. Install the web interface dependencies: `yarn install`
4. Go to the design system directory: `cd docs/graylog-luma`
5. Install design system dependencies: `yarn install`
6. Run `yarn storybook`
7. Open `http://localhost:6006`

## Contribute

To contribute, make changes to the design system source code [in the graylog2-server repo](https://github.com/Graylog2/graylog2-server/tree/master/graylog2-web-interface/docs/graylog-luma).