From ab17bb4acaab366b6837ed2a8c8ce9174d7ec56d Mon Sep 17 00:00:00 2001 From: Pocco81 Date: Wed, 25 May 2022 12:58:57 -0500 Subject: [PATCH] added style guide (WIP) --- docs/integration.md | 8 ++++++-- docs/style-guide.md | 12 ++++++++++++ 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/docs/integration.md b/docs/integration.md index efd6437..a876a15 100644 --- a/docs/integration.md +++ b/docs/integration.md @@ -1,5 +1,5 @@

-

🤝 Integration

+

📦 Integration

@@ -12,6 +12,8 @@ Catppuccin comes in many formats to cover a wide range of project types and tech stacks. Its palettes have especially been designed for UI elements and code syntax highlighting often found in projects build with web technologies like websites; hence why we have a dedicated repository for storing the various formats and presentation of the palettes: [catppuccin/palette](https://github.com/catppuccin/palette). +  + ### Web Development Since Catppuccin is heavily used in web technology based projects, it's main installation method is therefore npm, the Node.js package manager. @@ -21,6 +23,8 @@ Install and add it as production dependency by running `npm` from the command li npm install --save @catppuccin/palette ``` -### Design +  + +### Graphical Design Color swatches are simply a palette showing a variety of shades of the same color. Here, Catppuccin has various "swatches" in different formats to be used in software ranging from Adobe Products to graphical design apps such as Figma and InkScape. You can find them under [catppuccin/palette](https://github.com/catppuccin/palette). diff --git a/docs/style-guide.md b/docs/style-guide.md index f15cf21..0b91883 100644 --- a/docs/style-guide.md +++ b/docs/style-guide.md @@ -8,3 +8,15 @@

  + +### General Usage + +These are general use cases for most of the palette relevant for user interfaces. The `function` expresses a very vague use-case of a color and the `scope example` is how it is generally used: + +  + +### Terminals + +  + +### Code Editors