catppuccin/docs/README.md

33 lines
1.7 KiB
Markdown
Raw Normal View History

<p align="center">
<h2 align="center">📄 Docs</h2>
</p>
<p align="center">
2022-05-25 17:13:35 +00:00
Documentation for Catppuccin, the soothing pastel theme for the high-spirited!
</p>
2022-05-25 17:13:35 +00:00
<p align="center">
Catppuccin is a community-driven pastel theme that aims to be the middle ground between low and high contrast themes. It consists of 4 soothing warms palette with 26 eye-candy colors each, perfect for coding, designing, and much more! In addition, this repository tracks the development of the actual color palette, organization-wide assets, resources and code samples for maintainers/developers.
</p>
2022-05-25 17:18:46 +00:00
&nbsp;
2022-05-26 00:51:31 +00:00
<p align="center">
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/palette/demo.png" alt="catppuccin infrastructure"/>
2022-05-26 00:51:31 +00:00
</p>
&nbsp;
2022-05-25 17:15:19 +00:00
### 🪴 Index
+ [Specifications](https://github.com/catppuccin/catppuccin/blob/main/specs.md): properties of the palettes
+ [Integrating](https://github.com/catppuccin/catppuccin/blob/main/integration.md): how to implement Catppuccin in your own projects
+ [Style Guide](https://github.com/catppuccin/catppuccin/blob/main/style-guide.md): a guide on how to properly use the palettes
+ [Contributing](https://github.com/catppuccin/catppuccin/blob/main/contributing.md): creating Catppuccin ports
2022-05-25 17:18:46 +00:00
&nbsp;
<p align="center"><img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/footers/gray0_ctp_on_line.svg?sanitize=true" /></p>
2022-05-25 17:18:46 +00:00
<p align="center">Copyright &copy; 2021-present <a href="https://github.com/catppuccin" target="_blank">Catppuccin Org</a>
<p align="center"><a href="https://github.com/catppuccin/catppuccin/blob/main/LICENSE"><img src="https://img.shields.io/static/v1.svg?style=for-the-badge&label=License&message=MIT&logoColor=d9e0ee&colorA=302d41&colorB=c9cbff"/></a></p>