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.

Sign up for GitHub

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

docs(example): update the format of the themes for the example directory #1877

Merged
merged 1 commit into from
Oct 28, 2022
Merged

docs(example): update the format of the themes for the example directory #1877

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 15 additions & 3 deletions example/themes/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,19 @@
# Themes
Please make sure that the theme name and the file name are the same (+`.kdl`).

Themes can contain different flavors in one file, or can be created as individual files.

Example:

- theme: gruvbox
- filename: `gruvbox.kdl`
```
gruvbox.kdl
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is not a format we want in the example directory.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I apologize for doing the merge first.

At this point, I just wanted to make it clear that a single file can contain multiple themes, and I didn't think much more than that. Because there is a detailed explanation in the official documentation.

Do you think we need a more detailed explanation here?

├─ gruvbox-light
└─ gruvbox-dark

or

gruvbox-light.kdl
└─ gruvbox-light

gruvbox-dark.kdl
└─ gruvbox-dark
```