From b9bbd77c7fa1c11da6b700b01b173410a760e1e9 Mon Sep 17 00:00:00 2001 From: Hamothy <58985301+sgoudham@users.noreply.github.com> Date: Thu, 26 Jan 2023 18:53:05 +0000 Subject: [PATCH] docs: restructure & improve contrib docs (#1876) * docs: restructure & improve contrib docs * chore: rework samples code * docs: fix capitalization & brand names * docs: PR comments & try to standardise palette vs flavor * docs: add sample-programs * docs: update submission guidelines (refs: #1821) * refactor: tidy up docs Co-authored-by: winston --- CONTRIBUTING.md | 29 +- README.md | 68 +- docs/README.md | 9 +- docs/contributing.md | 82 -- docs/integration.md | 30 - docs/port-creation.md | 96 ++ docs/specs.md | 15 +- ...nslation_table.md => translation-table.md} | 0 samples/README.md | 11 + samples/bash.sh | 651 +---------- samples/coffee/0.coffee | 71 -- samples/coffeescript.coffee | 52 + samples/conf.ini | 110 -- samples/cpp.cpp | 1013 +---------------- samples/csharp.cs | 183 --- samples/css.css | 180 +-- samples/css/0.css | 32 - samples/go.go | 161 +++ samples/haskell.hs | 16 + samples/header.h | 131 --- samples/html.html | 54 +- samples/java.java | 121 +- samples/javascript.js | 33 + samples/javascript/0.js | 28 - samples/javascript/1.js | 88 -- samples/json.json | 39 +- samples/kotlin.kt | 68 ++ samples/lua.lua | 60 +- samples/markdown.md | 174 +++ samples/python.py | 204 +--- samples/python1.py | 815 ------------- samples/python2.py | 35 - samples/rust.rs | 117 ++ samples/rust/0.rs | 45 - samples/rust/1.rs | 961 ---------------- samples/scala.scala | 53 + samples/sql.sql | 14 + samples/toml.toml | 32 + samples/typescript.ts | 162 +-- samples/yaml.yaml | 19 + 40 files changed, 1210 insertions(+), 4852 deletions(-) delete mode 100644 docs/contributing.md delete mode 100644 docs/integration.md create mode 100644 docs/port-creation.md rename docs/{translation_table.md => translation-table.md} (100%) delete mode 100644 samples/coffee/0.coffee create mode 100644 samples/coffeescript.coffee delete mode 100644 samples/conf.ini delete mode 100644 samples/csharp.cs delete mode 100644 samples/css/0.css create mode 100644 samples/go.go create mode 100644 samples/haskell.hs delete mode 100644 samples/header.h create mode 100644 samples/javascript.js delete mode 100644 samples/javascript/0.js delete mode 100644 samples/javascript/1.js create mode 100644 samples/kotlin.kt create mode 100644 samples/markdown.md delete mode 100644 samples/python1.py delete mode 100644 samples/python2.py create mode 100644 samples/rust.rs delete mode 100644 samples/rust/0.rs delete mode 100644 samples/rust/1.rs create mode 100644 samples/scala.scala create mode 100644 samples/sql.sql create mode 100644 samples/toml.toml create mode 100644 samples/yaml.yaml diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 52b0334..05ff480 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -2,25 +2,22 @@ πŸŽ‰ First off, thanks for taking the time to contribute! πŸŽ‰ -> **Note**: if you are here because you want to submit a port/learn how to port Catppuccin to a program please refer to the [documentation](https://github.com/catppuccin/catppuccin/blob/main/docs/contributing.md) - ## Guidelines -The following is a set of guidelines for contributing to this project. Use your best judgment, and feel free to propose changes to this document in a pull request. +The following is a set of guidelines for contributing to this repository. Use your best judgment, and feel free to propose +changes to this document in a pull request. -- PRs should go to the `dev` branch. Reasons: - - If there is already stuff under development, then it's likely that a conflict may occur. - - Releases/Deployment. - - Documentation tends not to be updated by PRs. - - Testing. -- Use the `.editorconfig` file (located at the root of this project) on your editor so as to "maintain consistent coding styles". For instructions on how to use this file refer to [EditorConfig's website](https://editorconfig.org/). +- Use the `.editorconfig` file (located at the root of this project) on your editor to "maintain consistent coding + styles." For instructions on how to use this file refer to [EditorConfig's website](https://editorconfig.org/). ## Recommendations -- Create a topic branch on your fork for your specific PR. -- Consider using [conventionalcommits.org's](https://www.conventionalcommits.org/en/v1.0.0/) rules for creating explicit and meaningful commit messages. -- If it's your first time contributing to a project then read [About pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests) on Github's docs. - -## License - -Any contribution will be published under the same licensing terms as the project itself. +- Create a [topic branch](git-scm.com/book/en/v2/Git-Branching-Branching-Workflows#_topic_branch) on your fork for your + specific PR. +- Consider using [conventionalcommits.org](https://www.conventionalcommits.org/en/v1.0.0/)'s rules for creating explicit + and meaningful commit messages. +- If it's your first time contributing to a project then you should look to the + popular [first-contributions](https://github.com/firstcontributions/first-contributions) repository on GitHub. This + will give you hands-on experience with the features of GitHub required to make a contribution. As always, feel free to + join our [Discord](https://discord.com/invite/r6Mdz5dpFc) to ask any questions and clarify your understanding, we are + more than happy to help! diff --git a/README.md b/README.md index d161504..ff0a1b6 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@
- Palettes + Palette Β· Ports Β· @@ -33,7 +33,7 @@  

-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 warm palettes 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, the project's documentation, organization-wide assets, resources and code samples for maintainers/developers. +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 warm flavors 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, the project's documentation, organization-wide assets, resources and code samples for maintainers/developers.

@@ -58,16 +58,18 @@ Join our community! ### 🧠 Design Philosophy -- **Colorful is better than colorless**: the colorfulness of something contributes to the distinction amongst the parts of that _something_, making it marginally easier to understand how things are structured. -- **There should be balance**: not too dull, not too bright. Suitability under various light conditions is a must. -- **Harmony is superior to dissonance**: vivacious colors must complement each other. +- **Colorful is better than colorless**: the colorfulness of something contributes to the distinction amongst the parts + of that _something_, making it marginally easier to understand how things are structured. +- **There should be balance**: not too dull, not too bright. Suitability under various light conditions is a must. +- **Harmony is superior to dissonance**: vivacious colors must complement each other.   -### 🎨 Palettes +### 🎨 Palette -**Catppuccin** consists of 4 beautiful pastel color palettes. All the details can be found below.
-To make the best use of them, please refer to the [style guide](https://github.com/catppuccin/catppuccin/blob/main/docs/style-guide.md). +**Catppuccin** consists of 4 beautiful pastel color palettes, named **flavors**. All the details can be found below.
+To make the best use of them, please refer to +the [style guide](https://github.com/catppuccin/catppuccin/blob/main/docs/style-guide.md).

@@ -856,7 +858,7 @@ To make the best use of them, please refer to the [style guide](https://github.c Catppuccin is available for various apps and in different formats. Here is a list of them: -
πŸ‘Ύ Code Editors +
πŸ‘Ύ Code Editors - [Binary Ninja](https://github.com/catppuccin/binary-ninja) - [Cutter](https://github.com/catppuccin/cutter) @@ -880,6 +882,7 @@ Catppuccin is available for various apps and in different formats. Here is a lis - [Visual Studio](https://github.com/catppuccin/visual-studio) - [Xcode](https://github.com/catppuccin/xcode) - [Xed](https://github.com/catppuccin/xed) +
πŸ’­ Development @@ -891,7 +894,8 @@ Catppuccin is available for various apps and in different formats. Here is a lis - [Toolbox](https://github.com/catppuccin/toolbox) - [mdBook](https://github.com/catppuccin/mdBook) - [egui](https://github.com/catppuccin/egui) -
+ +
πŸ”§ System @@ -932,12 +936,14 @@ Catppuccin is available for various apps and in different formats. Here is a lis - [Waybar](https://github.com/catppuccin/waybar) - [Xresources](https://github.com/catppuccin/xresources) - [Rboard](https://github.com/catppuccin/rboard) +
🐚 Shells - [Fish](https://github.com/catppuccin/fish) - [zsh-syntax-highlighting](https://github.com/catppuccin/zsh-syntax-highlighting) +
πŸ€“ Productivity @@ -960,6 +966,7 @@ Catppuccin is available for various apps and in different formats. Here is a lis - [Vercel](https://github.com/catppuccin/vercel) - [Wikiwand](https://github.com/catppuccin/wikiwand) - [Zathura](https://github.com/catppuccin/zathura) +
🌈 Leisure @@ -977,9 +984,10 @@ Catppuccin is available for various apps and in different formats. Here is a lis - [Spicetify](https://github.com/catppuccin/spicetify) - [Spotify Player](https://github.com/catppuccin/spotify-player) - [Spotify-TUI](https://github.com/catppuccin/spotify-tui) -- [Stable Diffusion Web Ui](https://github.com/catppuccin/Stable-Diffusion-Web-UI) +- [Stable Diffusion Web UI](https://github.com/catppuccin/stable-diffusion-web-ui) - [Steam](https://github.com/catppuccin/steam) -- [Youtube Music](https://github.com/catppuccin/youtubemusic) +- [YouTube Music](https://github.com/catppuccin/youtubemusic) +
πŸ–₯️ Browsers @@ -988,6 +996,7 @@ Catppuccin is available for various apps and in different formats. Here is a lis - [Firefox](https://github.com/catppuccin/firefox) - [Vivaldi](https://github.com/catppuccin/vivaldi) - [qutebrowser](https://github.com/catppuccin/qutebrowser) +
πŸ”Ž Search engines @@ -995,8 +1004,9 @@ Catppuccin is available for various apps and in different formats. Here is a lis - [Brave Search](https://github.com/catppuccin/brave-search) - [DuckDuckGo](https://github.com/catppuccin/duckduckgo) - [Whoogle](https://github.com/catppuccin/whoogle) -- [SearxNG](https://github.com/catppuccin/searxng) +- [SearXNG](https://github.com/catppuccin/searxng) - [Startpage](https://github.com/catppuccin/startpage) +
🧩 Extensions @@ -1006,6 +1016,7 @@ Catppuccin is available for various apps and in different formats. Here is a lis - [Sidebery](https://github.com/catppuccin/sidebery) - [Vimium](https://github.com/catppuccin/vimium) - [Nighttab](https://github.com/catppuccin/nighttab) +
πŸ’¬ Messaging @@ -1020,6 +1031,7 @@ Catppuccin is available for various apps and in different formats. Here is a lis - [Revolt](https://github.com/catppuccin/revolt) - [Slack](https://github.com/catppuccin/slack) - [Telegram](https://github.com/catppuccin/telegram) +
πŸ“ Note-taking @@ -1028,6 +1040,7 @@ Catppuccin is available for various apps and in different formats. Here is a lis - [Joplin](https://github.com/catppuccin/joplin) - [Obsidian](https://github.com/catppuccin/obsidian) - [Remnote](https://github.com/catppuccin/remnote) +
🌱 Terminals @@ -1059,13 +1072,14 @@ Catppuccin is available for various apps and in different formats. Here is a lis - [Xfce4 Terminal](https://github.com/catppuccin/xfce4-terminal) - [Zellij](https://github.com/catppuccin/zellij) - [Zutty](https://github.com/catppuccin/zutty) +
✨ Social - [AniList](https://github.com/catppuccin/anilist) - [Elk](https://github.com/catppuccin/elk) -- [Github Readme Stats](https://github.com/catppuccin/github-readme-stats) +- [GitHub Readme Stats](https://github.com/catppuccin/github-readme-stats) - [GitHub Readme Tech Stack](https://github.com/catppuccin/github-readme-tech-stack) - [Hacker News](https://github.com/catppuccin/hacker-news) - [Infinity for Reddit](https://github.com/catppuccin/infinity) @@ -1077,6 +1091,7 @@ Catppuccin is available for various apps and in different formats. Here is a lis - [Reddit](https://github.com/catppuccin/reddit) - [Thunderbird](https://github.com/catppuccin/thunderbird) - [YouTube](https://github.com/catppuccin/youtube) +
  @@ -1085,23 +1100,38 @@ Catppuccin is available for various apps and in different formats. Here is a lis > **Note**
> Catppuccin staff reserve the right to remove and reject showcase additions if we determine the addition to be in -> violation of our [CODE OF CONDUCT](https://github.com/catppuccin/.github/blob/main/CODE_OF_CONDUCT.md). Extremely -> personal configurations will **not** be approved and added. +> violation of our [CODE OF CONDUCT](https://github.com/catppuccin/.github/blob/main/CODE_OF_CONDUCT.md). Extremely +> personal configurations and websites will **not** be added. If you're making an application or tool using our palette, please let us know by adding it below! - 🌟 [flotes.app](https://flotes.app/) - A free note-taking app enhanced with flashcard features -- 🌟 [AnuPpuccin](https://github.com/AnubisNekhet/AnuPpuccin) - Highly customisable theme for [Obsidian](https://obsidian.md/) -- 🌟 [name] - [short description] +- 🌟 [AnuPpuccin](https://github.com/AnubisNekhet/AnuPpuccin) - Highly customisable theme + for [Obsidian](https://obsidian.md/)   -### πŸ‘ Contribute +### πŸ‘ Contributing + +> **Note**
+> if you would like to submit a port or learn how to port Catppuccin to a program, please refer to +> the [port-creation.md](https://github.com/catppuccin/catppuccin/blob/main/docs/port-creation.md). See [CONTRIBUTING.md](https://github.com/catppuccin/catppuccin/blob/main/CONTRIBUTING.md).   +### πŸ”§ Usage + +If you're interested in using our palette for your own project, make sure to check +out [catppuccin/palette](https://github.com/catppuccin/palette) where you can find integrations with popular frameworks +and tools. + +If you already have a project using our palette, don't forget to add it to +our [showcase](#-showcase) section above! + +  + ### πŸ“œ License Catppuccin is released under the MIT license, which grants the following permissions: diff --git a/docs/README.md b/docs/README.md index 3a99ad0..f198fcb 100644 --- a/docs/README.md +++ b/docs/README.md @@ -7,7 +7,7 @@

-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. +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 warm flavors 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.

  @@ -20,10 +20,9 @@ Catppuccin is a community-driven pastel theme that aims to be the middle ground ### πŸͺ΄ Index -+ [Specifications](https://github.com/catppuccin/catppuccin/blob/main/docs/specs.md): properties of the palettes -+ [Integrating](https://github.com/catppuccin/catppuccin/blob/main/docs/integration.md): how to implement Catppuccin in your own projects -+ [Style Guide](https://github.com/catppuccin/catppuccin/blob/main/docs/style-guide.md): a guide on how to properly use the palettes -+ [Contributing](https://github.com/catppuccin/catppuccin/blob/main/docs/contributing.md): creating Catppuccin ports ++ [Specifications](https://github.com/catppuccin/catppuccin/blob/main/docs/specs.md): properties of the palette ++ [Style Guide](https://github.com/catppuccin/catppuccin/blob/main/docs/style-guide.md): a guide on how to properly use the palette ++ [Port Creation](https://github.com/catppuccin/catppuccin/blob/main/docs/port-creation.md): creating Catppuccin ports   diff --git a/docs/contributing.md b/docs/contributing.md deleted file mode 100644 index 2fa964a..0000000 --- a/docs/contributing.md +++ /dev/null @@ -1,82 +0,0 @@ -

-

🀝 Contributing

-

- -

- Creating Catppuccin ports -

- -  - -### What's a port? - -A port is basically an adaptation of Catppuccin's palettes for an app to use. Think of it as a colorscheme for a program that styles every UI component it consists of! - -  - -### Creation - -You can create ports using [this](https://github.com/catppuccin/template) public template as a blueprint. However, you must **not** create it the traditional way (by clicking **Use this template**), because this leaves a _small_ tag under the repos' name that says `generated from