Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat!: rebalance colors, adhere to style guide & overhaul docs #372

Merged
merged 25 commits into from
Oct 21, 2024
Merged
Show file tree
Hide file tree
Changes from 21 commits
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
62e2def
feat!: rebalance the colors used, and follow the styleguide
kjnsn Oct 13, 2024
ab339cc
fix(tests): add tests for window styling
kjnsn Oct 13, 2024
2ae20ce
refactor!: change how windows are styled
kjnsn Oct 13, 2024
5232d88
feat: rebalance the status module colors for cpu and battery
kjnsn Oct 13, 2024
2a09a8b
docs: update the preview images
kjnsn Oct 13, 2024
18ac3af
docs: update readme for v2 changes
kjnsn Oct 13, 2024
c460f25
docs: use a column layout for the preview
kjnsn Oct 13, 2024
8426abe
docs: add an example of a ram custom module
kjnsn Oct 13, 2024
f871b81
docs: use markdownlint to check README.md
kjnsn Oct 16, 2024
100dc10
docs: add a getting started guide
kjnsn Oct 16, 2024
93ff32f
docs: move the status line docs to the docs dir
kjnsn Oct 16, 2024
fcebb4b
docs: add basic demo using vhs
kjnsn Oct 16, 2024
b5fb282
docs: add config reference
kjnsn Oct 16, 2024
115a587
docs: move more docs into ./docs/
kjnsn Oct 17, 2024
7167e9e
docs: add design explanation
kjnsn Oct 19, 2024
7234a7a
chore: fix tests
kjnsn Oct 19, 2024
1314972
docs: add the version tag to the manual install instructions
kjnsn Oct 19, 2024
98db290
docs: fill out the design philosophy
kjnsn Oct 19, 2024
e13cbe4
chore: update issue templates and contributing.md
kjnsn Oct 19, 2024
9c9d9a9
Apply suggestions from code review
kjnsn Oct 19, 2024
9d9752a
docs: tidy up docs and add an updated structure image
kjnsn Oct 19, 2024
56d960f
docs: add instructions for gitmux
kjnsn Oct 19, 2024
2b2a3f3
docs: add a background to the structure image
kjnsn Oct 19, 2024
6050595
docs(CONTRIBUTING.md): add missing `[`
sgoudham Oct 21, 2024
32e33d4
feat!: change how status modules are styled
kjnsn Oct 21, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,13 @@ description: Report your bugs with the theme here!
labels: [bug]
body:
- type: checkboxes
attributes:
label: I am not requesting help with my configuration and believe something is genuinely broken.
description: Please open a [discussion](https://github.com/catppuccin/tmux/discussions/new?category=help) if you need support.
options:
- label: Something is really actually broken.
required: true
- type: checkboxes
attributes:
label: Is there an existing issue outlining your problem?
description: Please search to see if an issue already exists for your problem.
Expand All @@ -13,20 +20,13 @@ body:
attributes:
label: Describe your problem.
description: Also tell us, what do you expect to see?
placeholder: The battery charging icon is missing...
placeholder: The status bar is bright green, I expect it to be mantle.
validations:
required: true
- type: textarea
attributes:
label: Paste your configuration.
description: Provide us with the contents of your `.tmux.conf` file.
placeholder: |
```sh
set -g @plugin 'catppuccin/tmux'
set -g @plugin 'tmux-plugins/tpm'
# ...
run ~/.config/tmux/tpm/tpm
```
description: Provide us with the contents of your `~/.tmux.conf` file.
validations:
required: true
- type: textarea
Expand All @@ -37,7 +37,7 @@ body:
attributes:
label: What tmux version are you seeing the issue on?
description: "You can find your version by running `tmux -V`"
placeholder: tmux 3.3a
placeholder: tmux 3.5a
validations:
required: true
- type: textarea
Expand Down
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
blank_issues_enabled: false
contact_links:
- name: Ask A Question
url: https://github.com/catppuccin/tmux/discussions/new?category=q-a
- name: Get Support
url: https://github.com/catppuccin/tmux/discussions/new?category=help
about: Need help tweaking your Catppuccin tmux configuration? Ask questions in GitHub Discussions!
- name: Show & Tell
url: https://github.com/catppuccin/tmux/discussions/new?category=show-tell
Expand Down
3 changes: 2 additions & 1 deletion .github/release-please-config.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,8 @@
"bump-patch-for-minor-pre-major": false,
"draft": false,
"extra-files": [
"README.md"
"README.md",
"docs/tutorials/01-getting-started.md"
]
}
},
Expand Down
15 changes: 15 additions & 0 deletions .markdownlint.jsonc
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"$schema": "https://raw.githubusercontent.com/DavidAnson/markdownlint/v0.35.0/schema/markdownlint-config-schema.json",
"line-length": {
"code_block_line_length": 120,
"tables": false
},
"no-inline-html": {
"allowed_elements": ["details", "summary", "img", "p", "a", "h3"]
},
"first-line-heading": false,
"no-alt-text": false,
"code-block-style": {
"style": "consistent"
}
}
7 changes: 3 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
# Contributing

## Adding a module
## Design

Follow the instructions from [custom](/custom), place the module in the appropriate
directory and document the module in `README.md`.
To understand our mindset in developing this plugin and how to ensure your changes align with that mindset, check out the "[Design Philosophy(./docs/explanation/design.md)."

## Commit messages

Expand Down Expand Up @@ -36,7 +35,7 @@ described by Conventional Commits. Use the `<type>!` syntax in order to distingu
breaking commits in the log, but include the footer to provide a better description
for the changelog generator.

```
```text
feat(bar)!: foo the bars

BREAKING CHANGE: bars are now foo'ed
Expand Down
Loading