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(nixos-manual): init #1443

Merged
merged 32 commits into from
Nov 20, 2024
Merged

Conversation

husjon
Copy link
Contributor

@husjon husjon commented Nov 12, 2024

🎉 Theme for NixOS Manual (NixOS and nixpkgs) 🎉

NixOS Manual is the full documentation for both NixOS and nixpkgs.

preview

💬 Additional Comments 💬

It was pretty straight forward to get most of the styling in place, some elements were a bit more stubborn but this was mainly with highlightjs.
The preview screenshot is of the main page without the table of contents (since that takes up about 2 pages, not very interesting).
All links are dictated by the users accent color.

🗒 Checklist 🗒

  • I have read and followed Catppuccin's submission guidelines.
  • I have made a new directory underneath /styles/<name-of-website> containing the contents of the /template directory.
    • I have ensured that the new directory is in lower-kebab-case.
    • I have followed the template and kept the preprocessor as LESS.
  • I have made sure to update the
    userstyles.yml
    file with information about the new userstyle.
  • I have included the following files:
    • catppuccin.user.css - all the CSS for the userstyle, based on the
      template.
    • preview.webp - composite image of all four individual flavor screenshots (taken with the default accent color of mauve) stitched together, generated via Catwalk.

@husjon husjon requested a review from a team as a code owner November 12, 2024 01:36
Copy link
Member

@uncenter uncenter left a comment

Choose a reason for hiding this comment

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

Based on the preview image you have provided, I can see that there are unthemed horizontal dividers (maybe <hr> elements).

styles/nixos-manual/catppuccin.user.css Outdated Show resolved Hide resolved
@husjon
Copy link
Contributor Author

husjon commented Nov 12, 2024

Updated hr elements and highlight.js styling + preview image.

@husjon
Copy link
Contributor Author

husjon commented Nov 14, 2024

Hey @uncenter, just wanted to check if there was anything else needed regarding this PR. :)

@uncenter
Copy link
Member

Nothing needed from your end at the moment, we have a bit of a backlog of init PRs that I need to review first. Hopefully I can do a more thorough review later this week, luckily this userstyle is relatively small so it won't take very long.

@uncenter uncenter requested a review from isabelroses November 14, 2024 01:39
@isabelroses
Copy link
Member

I'm noticing quite a lot of linter errors. Some of them should be fixable with deno task lint:fix.

husjon and others added 3 commits November 14, 2024 12:47
Co-authored-by: uncenter <47499684+uncenter@users.noreply.github.com>
@husjon
Copy link
Contributor Author

husjon commented Nov 14, 2024

Thanks @isabelroses, the linter was unfortunately not able to fix them itself, instead I did so manually.

The following two errors might be possible to mitigate (to some degree) in the future is the following:

styles/nixos-manual/catppuccin.user.css:2
1│ /* ==UserStyle==
2│ @name nixos-manual Catppuccin
3│ @namespace github.com/catppuccin/userstyles/styles/nixos-manual
 ╰─► error UserCSS metadata property `@name` should be "NixOS Manual Catppuccin" but is "nixos-manual Catppuccin"

styles/nixos-manual/catppuccin.user.css:8
7│ @supportURL https://github.com/catppuccin/userstyles/issues?q=is%3Aopen+is%3Aissue+label%3Anixos-manual
8│ @description Soothing pastel theme for nixos-manual
9│ @author Catppuccin
 ╰─► error UserCSS metadata property `@description` should be "Soothing pastel theme for NixOS Manual" but is "Soothing pastel theme for nixos-manual"

In the template both of these use the <port-name> placeholder which is also used for the URLs, in my case I read these as "Use nixos-manual (aka lowercase kebab-case)" :)

@isabelroses
Copy link
Member

Thanks @isabelroses, the linter was unfortunately not able to fix them itself, instead I did so manually.

The following two errors might be possible to mitigate (to some degree) in the future is the following:

styles/nixos-manual/catppuccin.user.css:2
1│ /* ==UserStyle==
2│ @name nixos-manual Catppuccin
3│ @namespace github.com/catppuccin/userstyles/styles/nixos-manual
 ╰─► error UserCSS metadata property `@name` should be "NixOS Manual Catppuccin" but is "nixos-manual Catppuccin"

styles/nixos-manual/catppuccin.user.css:8
7│ @supportURL [https://github.com/catppuccin/userstyles/issues?q=is%3Aopen+is%3Aissue+label%3Anixos-manual](https://github.com/catppuccin/userstyles/issues?q=sort%3Aupdated-desc+is%3Aopen+is%3Aissue+label%3Anixos-manual)
8│ @description Soothing pastel theme for nixos-manual
9│ @author Catppuccin
 ╰─► error UserCSS metadata property `@description` should be "Soothing pastel theme for NixOS Manual" but is "Soothing pastel theme for nixos-manual"

In the template both of these use the <port-name> placeholder which is also used for the URLs, in my case I read these as "Use nixos-manual (aka lowercase kebab-case)" :)

Thanks for your feedback. ❤️

scripts/userstyles.yml Outdated Show resolved Hide resolved
styles/nixos-manual/catppuccin.user.css Outdated Show resolved Hide resolved
styles/nixos-manual/catppuccin.user.css Outdated Show resolved Hide resolved
styles/nixos-manual/catppuccin.user.css Outdated Show resolved Hide resolved
styles/nixos-manual/catppuccin.user.css Outdated Show resolved Hide resolved
styles/nixos-manual/catppuccin.user.css Outdated Show resolved Hide resolved
styles/nixos-manual/catppuccin.user.css Outdated Show resolved Hide resolved
husjon and others added 7 commits November 18, 2024 17:45
added category: wiki

Co-authored-by: uncenter <47499684+uncenter@users.noreply.github.com>
changed hr and table of content bottom border color to overlay1

Co-authored-by: uncenter <47499684+uncenter@users.noreply.github.com>
Co-authored-by: uncenter <47499684+uncenter@users.noreply.github.com>
Co-authored-by: uncenter <47499684+uncenter@users.noreply.github.com>
removed darken

Co-authored-by: uncenter <47499684+uncenter@users.noreply.github.com>
blue and green respectively
yellow and orange respectively
@husjon
Copy link
Contributor Author

husjon commented Nov 18, 2024

Thanks for the review @uncenter, everything should now be corrected including the preview image.

@uncenter uncenter self-requested a review November 18, 2024 17:31
styles/nixos-manual/catppuccin.user.css Outdated Show resolved Hide resolved
@uncenter
Copy link
Member

You can also add this snippet to theme examples https://nixos.org/manual/nixpkgs/stable/#sec-pkgs-fetchers-fetchzip-examples:

      div.example details[open] {
          border-color: @surface1 !important;
      }

Copy link
Member

@isabelroses isabelroses left a comment

Choose a reason for hiding this comment

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

The PR #1461 has yet to reach main but its best we add the % to save some duplicated effort.

I also didn't add % to anything that @uncenter's suggestions would have covered, since they already added them where appropriate.

styles/nixos-manual/catppuccin.user.css Outdated Show resolved Hide resolved
styles/nixos-manual/catppuccin.user.css Outdated Show resolved Hide resolved
husjon and others added 3 commits November 19, 2024 19:30
Co-authored-by: Isabel <isabel@isabelroses.com>
Co-authored-by: Isabel <isabel@isabelroses.com>
@husjon

This comment was marked as outdated.

@uncenter
Copy link
Member

Looks nice! However in userstyles we try to avoid changing the layout, padding, etc - anything that isn't color related. Feel free to use that part of the snippet as a separate userstyle on your own, or you could even contribute that CSS to the manual generator upstream.

@husjon
Copy link
Contributor Author

husjon commented Nov 19, 2024

Alright, make sense.
I've removed it from this PR.

styles/nixos-manual/catppuccin.user.css Show resolved Hide resolved
styles/nixos-manual/catppuccin.user.css Outdated Show resolved Hide resolved
husjon and others added 3 commits November 20, 2024 10:22
Co-authored-by: uncenter <47499684+uncenter@users.noreply.github.com>
Co-authored-by: uncenter <47499684+uncenter@users.noreply.github.com>
@uncenter uncenter requested a review from isabelroses November 20, 2024 12:29
Copy link
Member

@isabelroses isabelroses left a comment

Choose a reason for hiding this comment

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

Thanks for your work on the PR. ❤️

Shortly after this is merged you will be invited to the userstyles maintainers team, This will allow you the ability to merge PRs for your userstyle.

@isabelroses isabelroses merged commit 12984c1 into catppuccin:main Nov 20, 2024
1 check passed
@husjon husjon deleted the feat/nixos-manual branch November 20, 2024 19:28
@husjon
Copy link
Contributor Author

husjon commented Nov 20, 2024

Awesome and thank you.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants