diff --git a/.editorconfig b/.editorconfig index d86ac02..be84ee6 100644 --- a/.editorconfig +++ b/.editorconfig @@ -32,3 +32,7 @@ trim_trailing_whitespace = false # windows shell scripts [*.{cmd,bat,ps1}] end_of_line = crlf + +# npins +[.sources/sources.json] +trim_trailing_whitespace = false diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml new file mode 100644 index 0000000..da04775 --- /dev/null +++ b/.github/workflows/deploy.yml @@ -0,0 +1,61 @@ +name: Build & deploy website + +on: + push: + branches: [main] + pull_request: + workflow_dispatch: + +jobs: + build: + name: Build site + + runs-on: ubuntu-latest + + steps: + - name: Checkout repository + uses: actions/checkout@v4 + + - name: Install Nix + uses: cachix/install-nix-action@v26 + + - name: Setup cache + uses: DeterminateSystems/magic-nix-cache-action@v6 + + - name: Run build + run: | + nix build \ + --print-build-logs \ + --show-trace \ + './dev#site' + + - name: Get artifact directory + id: find-path + run: | + # exit if no `result` from `nix build` + [ ! -L result ] && exit 1 + echo "path=$(readlink -f result)" >> "$GITHUB_OUTPUT" + + - name: Upload Pages artifact + uses: actions/upload-pages-artifact@v3 + with: + path: ${{ steps.find-path.outputs.path }} + + deploy: + name: Deploy website + if: github.event_name == 'push' || github.event_name == 'workflow_dispatch' + + runs-on: ubuntu-latest + + environment: + name: github-pages + url: ${{ steps.deploy.outputs.page_url }} + + permissions: + id-token: write + pages: write + + steps: + - name: Deploy to GitHub Pages + id: deploy + uses: actions/deploy-pages@v4 diff --git a/.github/workflows/update-docs.yml b/.github/workflows/update-docs.yml deleted file mode 100644 index bf62f92..0000000 --- a/.github/workflows/update-docs.yml +++ /dev/null @@ -1,49 +0,0 @@ -name: Update docs - -on: - push: - branches: [main] - paths: - - "modules/home-manager/**" - - "modules/nixos/**" - workflow_dispatch: - -jobs: - update: - name: Run update - runs-on: ubuntu-latest - # we only want this running on our repo - if: github.repository == 'catppuccin/nix' - - steps: - - uses: actions/checkout@v4 - with: - token: ${{ secrets.PUSH_TOKEN }} - - - name: Install Nix - uses: cachix/install-nix-action@V27 - - - name: Set Git user info - run: | - git config user.name 'github-actions[bot]' - git config user.email 'github-actions[bot]@users.noreply.github.com' - - - name: Get short revision - id: rev - run: - echo "rev=$(git rev-parse --short HEAD)" >> "$GITHUB_OUTPUT" - - - name: Build & update docs - run: | - for module in "nixos" "home-manager"; do - nix build --print-build-logs --show-trace ./dev#"$module"-doc - cat result > docs/"$module"-options.md - rm result - done - - - name: Commit changes - run: | - if ! git diff --color=always --exit-code; then - git commit -am "docs: update for ${{ steps.rev.outputs.rev }}" - git push - fi diff --git a/.gitignore b/.gitignore index 7dc3520..b272df7 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,8 @@ +# mdbook artifacts +**/book + +# nix artifacts result result-* +repl-result-* diff --git a/README.md b/README.md index c2d13fb..678b8e4 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,8 @@ ## Usage +You will probably want to see our [Getting started guide](http://nix.catppuccin.com/getting-started/index.html), but as a TLDR: + 1. Import the [NixOS](https://nixos.org) and [home-manager](https://github.com/nix-community/home-manager) modules
@@ -44,7 +46,7 @@ ```nix { inputs = { - nixpkgs.url = "nixpkgs/nixos-22.11"; + nixpkgs.url = "nixpkgs/nixos-unstable"; catppuccin.url = "github:catppuccin/nix"; home-manager = { url = "github:nix-community/home-manager"; @@ -52,18 +54,18 @@ }; }; - outputs = { nixpkgs, catppuccin, home-manager }: let - system = "x86_64-linux"; - pkgs = import nixpkgs {inherit system;}; - in { + outputs = { nixpkgs, catppuccin, home-manager }: { # for nixos module home-manager installations - nixosConfigurations.host = pkgs.lib.nixosSystem { - inherit system; + nixosConfigurations.pepperjacksComputer = pkgs.lib.nixosSystem { + system = "x86_64-linux"; modules = [ catppuccin.nixosModules.catppuccin + # if you use home-manager home-manager.nixosModules.home-manager + { - home-manager.users.user = { + # if you use home-manager + home-manager.users.pepperjack = { imports = [ ./home.nix catppuccin.homeManagerModules.catppuccin @@ -74,9 +76,10 @@ }; # for standalone home-manager installations - homeConfigurations.user = home-manager.lib.homeManagerConfiguration { - inherit pkgs; + homeConfigurations.pepperjack = home-manager.lib.homeManagerConfiguration { + pkgs = nixpkgs.legacyPackages.x86_64-linux; modules = [ + ./home.nix catppuccin.homeManagerModules.catppuccin ]; }; @@ -100,11 +103,13 @@ For [NixOS module installations](https://nix-community.github.io/home-manager/in ```nix { imports = [ - + # if you use home-manager + ]; - home-manager.users.user = { + # if you use home-manager + home-manager.users.pepperjack = { imports = [ ]; @@ -121,8 +126,7 @@ For [standalone installations](https://nix-community.github.io/home-manager/inde ]; - home.username = "user"; - home.homeDirectory = "user"; + home.username = "pepperjack"; programs.home-manager.enable = true; } ``` @@ -148,11 +152,22 @@ For [standalone installations](https://nix-community.github.io/home-manager/inde } ``` +4. Enable for all available programs you're using! + +```nix +{ + catppuccin.enable = true; +} +``` + ## 🙋 FAQ - Q: **"How do I know what programs are supported?"**\ - A: You can find programs supported through home-manager [here](https://github.com/catppuccin/nix/tree/main/modules/home-manager), - and NixOS modules [here](https://github.com/catppuccin/nix/tree/main/modules/nixos) + A: You can find programs supported through home-manager [here](https://nix.catppuccin.com/options/home-manager-options.html), + and NixOS modules [here](https://nix.catppuccin.com/options/nixos-options.html) + +- Q: **"How do I set `catppuccin.enable` for everything I use?"**\ + A: You can set `catppuccin.enable` [globally](options/nixos-options.md#catppuccinenable) - Q: **"What versions of NixOS and home-manager are supported?"**\ A: We primarily support the `unstable` branch, but try our best to support the current stable release. diff --git a/default.nix b/default.nix deleted file mode 100644 index 4393224..0000000 --- a/default.nix +++ /dev/null @@ -1,9 +0,0 @@ -(import - ( - fetchTarball { - url = "https://github.com/edolstra/flake-compat/archive/0f9255e01c2351cc7d116c072cb317785dd33b33.tar.gz"; - sha256 = "sha256-kvjfFW7WAETZlt09AgDn1MrtKzP7t90Vf7vypd3OL1U="; - } - ) - { src = ./.; } -).defaultNix diff --git a/dev/flake.nix b/dev/flake.nix index 13616bd..7c4de8e 100644 --- a/dev/flake.nix +++ b/dev/flake.nix @@ -33,7 +33,7 @@ forAllSystems = fn: nixpkgs.lib.genAttrs systems (system: fn nixpkgsFor.${system}.unstable); in { - apps = forAllSystems ({ lib, pkgs, ... }: { + apps = forAllSystems ({ lib, pkgs, system, ... }: { add-source = { type = "app"; program = lib.getExe ( @@ -49,6 +49,11 @@ '' ); }; + + serve = { + type = "app"; + program = lib.getExe self.packages.${system}.site.serve; + }; }); checks = forAllSystems ({ lib, pkgs, system, ... }: lib.optionalAttrs pkgs.stdenv.isLinux { @@ -60,21 +65,42 @@ formatter = forAllSystems (pkgs: pkgs.nixpkgs-fmt); - packages = forAllSystems (pkgs: + packages = forAllSystems ({ lib, pkgs, system, ... }: let version = self.shortRev or self.dirtyShortRev or "unknown"; - mkOptionDoc = args: (pkgs.callPackage ./option-doc.nix { }) (args // { inherit version; }); + mkOptionDoc = pkgs.callPackage ../docs/options-doc.nix { }; + mkSite = pkgs.callPackage ../docs/mk-site.nix { }; + packages' = self.packages.${system}; in { nixos-doc = mkOptionDoc { + inherit version; modules = [ ../modules/nixos ]; }; home-manager-doc = mkOptionDoc { + inherit version; modules = [ ../modules/home-manager ]; }; - default = self.packages.${pkgs.system}.home-manager-doc; + site = mkSite { + pname = "catppuccin-nix-website"; + inherit version; + + src = lib.fileset.toSource { + root = ../docs; + fileset = lib.fileset.unions [ + ../docs/src + ../docs/book.toml + ../docs/theme + ]; + }; + + nixosDoc = packages'.nixos-doc; + homeManagerDoc = packages'.home-manager-doc; + }; + + default = packages'.site; }); }; } diff --git a/dev/option-doc.nix b/dev/option-doc.nix deleted file mode 100644 index 96edc0a..0000000 --- a/dev/option-doc.nix +++ /dev/null @@ -1,29 +0,0 @@ -{ lib -, nixosOptionsDoc -, -}: { version - , modules - , - }: -let - eval = lib.evalModules { - modules = modules ++ [{ - options.system.nixos.release = lib.mkOption { - type = lib.types.str; - default = lib.trivial.release; - readOnly = true; - }; - - config = { - _module.check = false; - }; - }]; - }; - - doc = nixosOptionsDoc { - options = lib.filterAttrs (n: lib.const (!(lib.elem n [ "_module" "system" ]))) eval.options; - documentType = "none"; - revision = version; - }; -in -doc.optionsCommonMark diff --git a/docs/book.toml b/docs/book.toml new file mode 100644 index 0000000..09cb7eb --- /dev/null +++ b/docs/book.toml @@ -0,0 +1,16 @@ +[book] +title = "catppuccin/nix" +authors = ["getchoo"] +description = "Soothing pastel theme for Nix" +language = "en" +multilingual = false +src = "src" + +[output.html] +default-theme = "mocha" +preferred-dark-theme = "mocha" +additional-css = ["./theme/catppuccin.css"] +no-section-label = true +git-repository-url = "https://github.com/catppuccin/nix" +git-repository-icon = "fa-github" +cname = "nix.catppuccin.com" diff --git a/docs/home-manager-options.md b/docs/home-manager-options.md deleted file mode 100644 index 7bbd0d1..0000000 --- a/docs/home-manager-options.md +++ /dev/null @@ -1,2360 +0,0 @@ -## catppuccin\.enable - - - -Whether to enable Catppuccin globally\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## catppuccin\.accent - -Global Catppuccin accent - - - -*Type:* -one of “blue”, “flamingo”, “green”, “lavender”, “maroon”, “mauve”, “peach”, “pink”, “red”, “rosewater”, “sapphire”, “sky”, “teal”, “yellow” - - - -*Default:* -` "mauve" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## catppuccin\.flavour - - - -Global Catppuccin flavour - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## catppuccin\.sources - - - -Port sources used across all options - - - -*Type:* -lazy attribute set of raw value - - - -*Default:* -` "{ ... }" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## gtk\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## gtk\.catppuccin\.accent - - - -Catppuccin accent for gtk - - - -*Type:* -one of “blue”, “flamingo”, “green”, “lavender”, “maroon”, “mauve”, “peach”, “pink”, “red”, “rosewater”, “sapphire”, “sky”, “teal”, “yellow” - - - -*Default:* -` "mauve" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## gtk\.catppuccin\.cursor\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## gtk\.catppuccin\.cursor\.accent - - - -Catppuccin accent for gtk cursors - - - -*Type:* -one of “blue”, “flamingo”, “green”, “lavender”, “maroon”, “mauve”, “peach”, “pink”, “red”, “rosewater”, “sapphire”, “sky”, “teal”, “yellow”, “dark”, “light” - - - -*Default:* -` "mauve" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## gtk\.catppuccin\.cursor\.flavour - - - -Catppuccin flavour for gtk cursors - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## gtk\.catppuccin\.flavour - - - -Catppuccin flavour for gtk - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## gtk\.catppuccin\.gnomeShellTheme - - - -Whether to enable Catppuccin gtk theme for GNOME Shell\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## gtk\.catppuccin\.icon\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## gtk\.catppuccin\.icon\.accent - - - -Catppuccin accent for gtk modified Papirus icon theme - - - -*Type:* -one of “blue”, “flamingo”, “green”, “lavender”, “maroon”, “mauve”, “peach”, “pink”, “red”, “rosewater”, “sapphire”, “sky”, “teal”, “yellow” - - - -*Default:* -` "mauve" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## gtk\.catppuccin\.icon\.flavour - - - -Catppuccin flavour for gtk modified Papirus icon theme - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## gtk\.catppuccin\.size - - - -Catppuccin size variant for gtk - - - -*Type:* -one of “standard”, “compact” - - - -*Default:* -` "standard" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## gtk\.catppuccin\.tweaks - - - -Catppuccin tweaks for gtk - - - -*Type:* -list of (one of “black”, “rimless”, “normal”) - - - -*Default:* - -``` -[ - "normal" -] -``` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## i18n\.inputMethod\.fcitx5\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## i18n\.inputMethod\.fcitx5\.catppuccin\.apply - - - -Applies the theme by overwriting ` $XDG_CONFIG_HOME/fcitx5/conf/classicui.conf `\. -If this is disabled, you must manually set the theme (e\.g\. by using ` fcitx5-configtool `)\. - - - -*Type:* -boolean - - - -*Default:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## i18n\.inputMethod\.fcitx5\.catppuccin\.flavour - - - -Catppuccin flavour for Fcitx5 - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.alacritty\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.alacritty\.catppuccin\.flavour - - - -Catppuccin flavour for alacritty - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.bat\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.bat\.catppuccin\.flavour - - - -Catppuccin flavour for bat - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.bottom\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.bottom\.catppuccin\.flavour - - - -Catppuccin flavour for bottom - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.btop\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.btop\.catppuccin\.flavour - - - -Catppuccin flavour for btop - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.cava\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.cava\.catppuccin\.flavour - - - -Catppuccin flavour for cava - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.fish\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.fish\.catppuccin\.flavour - - - -Catppuccin flavour for fish - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.foot\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.foot\.catppuccin\.flavour - - - -Catppuccin flavour for foot - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.fzf\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.fzf\.catppuccin\.flavour - - - -Catppuccin flavour for fzf - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.gh-dash\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.gh-dash\.catppuccin\.accent - - - -Catppuccin accent for gh-dash - - - -*Type:* -one of “blue”, “flamingo”, “green”, “lavender”, “maroon”, “mauve”, “peach”, “pink”, “red”, “rosewater”, “sapphire”, “sky”, “teal”, “yellow” - - - -*Default:* -` "mauve" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.gh-dash\.catppuccin\.flavour - - - -Catppuccin flavour for gh-dash - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.git\.delta\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.git\.delta\.catppuccin\.flavour - - - -Catppuccin flavour for catppuccin - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.gitui\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.gitui\.catppuccin\.flavour - - - -Catppuccin flavour for gitui - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.glamour\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.glamour\.catppuccin\.flavour - - - -Catppuccin flavour for glamour - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.helix\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.helix\.catppuccin\.flavour - - - -Catppuccin flavour for helix - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.helix\.catppuccin\.useItalics - - - -Whether to enable Italics in Catppuccin theme for Helix\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.imv\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.imv\.catppuccin\.flavour - - - -Catppuccin flavour for imv - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.k9s\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.k9s\.catppuccin\.flavour - - - -Catppuccin flavour for k9s - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.k9s\.catppuccin\.transparent - - - -Whether to enable transparent version of flavour\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.kitty\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.kitty\.catppuccin\.flavour - - - -Catppuccin flavour for kitty - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.lazygit\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.lazygit\.catppuccin\.accent - - - -Catppuccin accent for lazygit - - - -*Type:* -one of “blue”, “flamingo”, “green”, “lavender”, “maroon”, “mauve”, “peach”, “pink”, “red”, “rosewater”, “sapphire”, “sky”, “teal”, “yellow” - - - -*Default:* -` "mauve" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.lazygit\.catppuccin\.flavour - - - -Catppuccin flavour for lazygit - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.micro\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.micro\.catppuccin\.flavour - - - -Catppuccin flavour for micro - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.mpv\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.mpv\.catppuccin\.accent - - - -Catppuccin accent for mpv - - - -*Type:* -one of “blue”, “flamingo”, “green”, “lavender”, “maroon”, “mauve”, “peach”, “pink”, “red”, “rosewater”, “sapphire”, “sky”, “teal”, “yellow” - - - -*Default:* -` "mauve" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.mpv\.catppuccin\.flavour - - - -Catppuccin flavour for mpv - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.neovim\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.neovim\.catppuccin\.flavour - - - -Catppuccin flavour for neovim - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.rio\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.rio\.catppuccin\.flavour - - - -Catppuccin flavour for rio - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.rofi\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.rofi\.catppuccin\.flavour - - - -Catppuccin flavour for rofi - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.skim\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.skim\.catppuccin\.flavour - - - -Catppuccin flavour for skim - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.starship\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.starship\.catppuccin\.flavour - - - -Catppuccin flavour for starship - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.swaylock\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.swaylock\.catppuccin\.flavour - - - -Catppuccin flavour for swaylock - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.tmux\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.tmux\.catppuccin\.extraConfig - - - -Additional configuration for the catppuccin plugin\. - - - -*Type:* -strings concatenated with “\\n” - - - -*Default:* -` "" ` - - - -*Example:* - -``` -'' - set -g @catppuccin_status_modules_right "application session user host date_time" -'' -``` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.tmux\.catppuccin\.flavour - - - -Catppuccin flavour for tmux - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.tofi\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.tofi\.catppuccin\.flavour - - - -Catppuccin flavour for tofi - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.waybar\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.waybar\.catppuccin\.flavour - - - -Catppuccin flavour for waybar - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.waybar\.catppuccin\.mode - - - -Defines how to include the catppuccin theme css file: - - - ` prependImport `: Prepends the import statement, if ` programs.waybar.style ` is a string (with default override priority)\. - - ` createLink `: Creates a symbolic link ` ~/.config/waybar/catppuccin.css `, which needs to be included in the waybar stylesheet\. - - - -*Type:* -one of “prependImport”, “createLink” - - - -*Default:* -` "prependImport" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.yazi\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.yazi\.catppuccin\.flavour - - - -Catppuccin flavour for yazi - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.zathura\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.zathura\.catppuccin\.flavour - - - -Catppuccin flavour for zathura - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.zellij\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.zellij\.catppuccin\.flavour - - - -Catppuccin flavour for zellij - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.zsh\.syntaxHighlighting\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## programs\.zsh\.syntaxHighlighting\.catppuccin\.flavour - - - -Catppuccin flavour for zsh syntax highlighting - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## services\.dunst\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## services\.dunst\.catppuccin\.flavour - - - -Catppuccin flavour for dunst - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## services\.mako\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## services\.mako\.catppuccin\.flavour - - - -Catppuccin flavour for mako - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## services\.polybar\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## services\.polybar\.catppuccin\.flavour - - - -Catppuccin flavour for polybar - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## wayland\.windowManager\.hyprland\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## wayland\.windowManager\.hyprland\.catppuccin\.accent - - - -Catppuccin accent for hyprland - - - -*Type:* -one of “blue”, “flamingo”, “green”, “lavender”, “maroon”, “mauve”, “peach”, “pink”, “red”, “rosewater”, “sapphire”, “sky”, “teal”, “yellow” - - - -*Default:* -` "mauve" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## wayland\.windowManager\.hyprland\.catppuccin\.flavour - - - -Catppuccin flavour for hyprland - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## wayland\.windowManager\.sway\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - - -## wayland\.windowManager\.sway\.catppuccin\.flavour - -Catppuccin flavour for sway - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager](file:///nix/store/kbd2mcji4s1nnnmfagb4cay3avv4m5aw-source/modules/home-manager) - - diff --git a/docs/mk-site.nix b/docs/mk-site.nix new file mode 100644 index 0000000..a888c67 --- /dev/null +++ b/docs/mk-site.nix @@ -0,0 +1,48 @@ +{ lib +, stdenvNoCC +, writeShellApplication +, mdbook +, python3 +}: { nixosDoc + , homeManagerDoc + , ... + }@args: +stdenvNoCC.mkDerivation (finalAttrs: args // { + nativeBuildInputs = [ + mdbook + ]; + + dontPatch = true; + dontConfigure = true; + doCheck = false; + + buildPhase = '' + runHook preBuild + + ln -s ${nixosDoc} src/options/nixos-options.md + ln -s ${homeManagerDoc} src/options/home-manager-options.md + mdbook build + + runHook postBuild + ''; + + installPhase = '' + runHook preInstall + + mv book $out + + runHook postInstall + ''; + + passthru = { + serve = writeShellApplication { + name = "serve"; + + runtimeInputs = [ python3 ]; + + text = '' + python -m http.server --bind 127.0.0.1 --directory ${finalAttrs.finalPackage} + ''; + }; + }; +}) diff --git a/docs/nixos-options.md b/docs/nixos-options.md deleted file mode 100644 index 6b45fe4..0000000 --- a/docs/nixos-options.md +++ /dev/null @@ -1,358 +0,0 @@ -## boot\.loader\.grub\.catppuccin\.enable - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos](file:///nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos) - - - -## boot\.loader\.grub\.catppuccin\.flavour - - - -Catppuccin flavour for grub - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos](file:///nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos) - - - -## boot\.plymouth\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos](file:///nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos) - - - -## boot\.plymouth\.catppuccin\.flavour - - - -Catppuccin flavour for plymouth - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos](file:///nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos) - - - -## catppuccin\.enable - - - -Whether to enable Catppuccin globally\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos](file:///nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos) - - - -## catppuccin\.accent - - - -Global Catppuccin accent - - - -*Type:* -one of “blue”, “flamingo”, “green”, “lavender”, “maroon”, “mauve”, “peach”, “pink”, “red”, “rosewater”, “sapphire”, “sky”, “teal”, “yellow” - - - -*Default:* -` "mauve" ` - -*Declared by:* - - [/nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos](file:///nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos) - - - -## catppuccin\.flavour - - - -Global Catppuccin flavour - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos](file:///nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos) - - - -## catppuccin\.sources - - - -Port sources used across all options - - - -*Type:* -lazy attribute set of raw value - - - -*Default:* -` "{ ... }" ` - -*Declared by:* - - [/nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos](file:///nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos) - - - -## console\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos](file:///nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos) - - - -## console\.catppuccin\.flavour - - - -Catppuccin flavour for console - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos](file:///nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos) - - - -## services\.displayManager\.sddm\.catppuccin\.enable - - - -Whether to enable Catppuccin theme\. - - - -*Type:* -boolean - - - -*Default:* -` false ` - - - -*Example:* -` true ` - -*Declared by:* - - [/nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos](file:///nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos) - - - -## services\.displayManager\.sddm\.catppuccin\.background - - - -Background image to use for the login screen - - - -*Type:* -path or string - - - -*Default:* -` "" ` - -*Declared by:* - - [/nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos](file:///nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos) - - - -## services\.displayManager\.sddm\.catppuccin\.flavour - - - -Catppuccin flavour for sddm - - - -*Type:* -one of “latte”, “frappe”, “macchiato”, “mocha” - - - -*Default:* -` "mocha" ` - -*Declared by:* - - [/nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos](file:///nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos) - - - -## services\.displayManager\.sddm\.catppuccin\.font - - - -Font to use for the login screen - - - -*Type:* -string - - - -*Default:* -` "Noto Sans" ` - -*Declared by:* - - [/nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos](file:///nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos) - - - -## services\.displayManager\.sddm\.catppuccin\.fontSize - - - -Font size to use for the login screen - - - -*Type:* -string - - - -*Default:* -` "9" ` - -*Declared by:* - - [/nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos](file:///nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos) - - - -## services\.displayManager\.sddm\.catppuccin\.loginBackground - - - -Add an additional background layer to the login panel - - - -*Type:* -boolean - - - -*Default:* -` true ` - -*Declared by:* - - [/nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos](file:///nix/store/0l5anlzfsi1xv9f0an30ijk4m86vam9z-source/modules/nixos) - - diff --git a/docs/options-doc.nix b/docs/options-doc.nix new file mode 100644 index 0000000..6bec83c --- /dev/null +++ b/docs/options-doc.nix @@ -0,0 +1,33 @@ +{ lib +, nixosOptionsDoc +, +}: { version + , modules + , + }: +( + nixosOptionsDoc { + options = + builtins.removeAttrs + ( + lib.evalModules { + modules = modules ++ [{ + options.system.nixos.release = lib.mkOption { + type = lib.types.str; + default = lib.trivial.release; + readOnly = true; + }; + + config = { + _module.check = false; + }; + }]; + } + ).options [ "_module" "system" ]; + + transformOptions = opt: builtins.removeAttrs opt [ "declarations" ]; + + documentType = "none"; + revision = version; + } +).optionsCommonMark diff --git a/docs/src/CONTRIBUTING.md b/docs/src/CONTRIBUTING.md new file mode 100644 index 0000000..debc754 --- /dev/null +++ b/docs/src/CONTRIBUTING.md @@ -0,0 +1,5 @@ +# Contributing + +`catppuccin/nix` is an open source, [MIT licensed](https://github.com/catppuccin/nix/blob/main/LICENSE) project. Contributions - including bug reports, feature requests, and improvements - can be made on our [GitHub repository](https://github.com/catppuccin/nix). + +If you are interested in hacking away at our modules, make sure to read our [Contributing guidelines](https://github.com/catppuccin/nix/blob/main/CONTRIBUTING.md) diff --git a/docs/src/NEWS.md b/docs/src/NEWS.md new file mode 100644 index 0000000..1f942bc --- /dev/null +++ b/docs/src/NEWS.md @@ -0,0 +1,3 @@ +# Changelog + +We haven't had a release just yet. Check back soon! diff --git a/docs/src/README.md b/docs/src/README.md new file mode 100644 index 0000000..e5f763c --- /dev/null +++ b/docs/src/README.md @@ -0,0 +1,16 @@ +# catppuccin/nix + +*The soothing pastel theme - now for Nix!* + +Built on top of [NixOS](https://nixos.org) and [home-manager](https://github.com/nix-community/home-manager), `catppuccin/nix` allows you to easily use Catppuccin across all of your apps! + +## What you'll find here + +You should first check out our [Getting started](getting-started) guide. Once you're done, you can take a look at all of our available options: + +- [For NixOS](options/nixos-options.md) +- [For home-manager](options/home-manager-options.md) + +## Find a problem? + +Feel free to [open an issue!](https://github.com/catppuccin/nix/issues/new) diff --git a/docs/src/SUMMARY.md b/docs/src/SUMMARY.md new file mode 100644 index 0000000..4f26eac --- /dev/null +++ b/docs/src/SUMMARY.md @@ -0,0 +1,17 @@ +# Summary + +[Introduction](README.md) + +- [Getting started](getting-started/README.md) + - [Stable Nix](getting-started/stable-nix.md) + - [Flakes](getting-started/flakes.md) + +- [Module options](options/README.md) + - [NixOS](options/nixos-options.md) + - [home-manager](options/home-manager-options.md) + +- [FAQ](faq.md) + +- [Changelog](NEWS.md) + +- [Contributing](CONTRIBUTING.md) diff --git a/docs/src/faq.md b/docs/src/faq.md new file mode 100644 index 0000000..ab8f1a3 --- /dev/null +++ b/docs/src/faq.md @@ -0,0 +1,12 @@ +# FAQ + +- Q: **"How do I know what programs are supported?"**\ + A: You can find programs supported through home-manager [here](options/home-manager-options.md), + and NixOS modules [here](options/nixos-options.md) + +- Q: **"How do I set `catppuccin.enable` for everything I use?"**\ + A: You can set `catppuccin.enable` [globally](options/nixos-options.md#catppuccinenable) + +- Q: **"What versions of NixOS and home-manager are supported?"**\ + A: We primarily support the `unstable` branch, but try our best to support the current stable release. + You can check if your stable release is currently supported at [status.nixos.org](https://status.nixos.org/) diff --git a/docs/src/getting-started/README.md b/docs/src/getting-started/README.md new file mode 100644 index 0000000..2e6db29 --- /dev/null +++ b/docs/src/getting-started/README.md @@ -0,0 +1,6 @@ +# Getting started + +`catppuccin/nix` supports both stable Nix and [Flakes](https://wiki.nixos.org/wiki/Flakes)! Select one of the options below based on what you want to use. + +- [Stable Nix](stable-nix.md) +- [Flakes](flakes.md) diff --git a/docs/src/getting-started/flakes.md b/docs/src/getting-started/flakes.md new file mode 100644 index 0000000..c78eb5c --- /dev/null +++ b/docs/src/getting-started/flakes.md @@ -0,0 +1,100 @@ +# Flakes + +Flakes are the preferred way to to use `catppuccin/nix` and will be the easiest method for those with them enabled + + +First, we need to add this project to our inputs so we can use it in our configurations: + +```nix +{ + inputs = { + nixpkgs.url = "nixpkgs/nixos-unstable"; + catppuccin.url = "github:catppuccin/nix"; + }; +} +``` + +After, we can use them in a NixOS configuration like so + +```nix +{ + nixosConfigurations.pepperjacksComputer = { + system = "x86_64-linux"; + + modules = [ + catppuccin.nixosModules.catppuccin + # if you use home-manager + home-manager.nixosModules.home-manager + + { + # if you use home-manager + home-manager.users.pepperjack = { + imports = [ + ./home.nix + catppuccin.homeManagerModules.catppuccin + ]; + }; + } + ]; + }; +} +``` + +or if you use a [standalone installation](https://nix-community.github.io/home-manager/index.html#sec-install-standalone) of `home-manager` + +```nix +{ + homeConfigurations.pepperjack = home-manager.lib.homeManagerConfiguration { + pkgs = nixpkgs.legacyPackages.x86_64-linux; + modules = [ + ./home.nix + catppuccin.homeManagerModules.catppuccin + ]; + }; +} +``` + +By the end, you should have a flake.nix that looks something like this +```nix +{ + inputs = { + nixpkgs.url = "nixpkgs/nixos-unstable"; + catppuccin.url = "github:catppuccin/nix"; + home-manager = { + url = "github:nix-community/home-manager"; + inputs.nixpkgs.follows = "nixpkgs"; + }; + }; + + outputs = { nixpkgs, catppuccin, home-manager }: { + # for nixos module home-manager installations + nixosConfigurations.pepperjacksComputer = pkgs.lib.nixosSystem { + system = "x86_64-linux"; + modules = [ + catppuccin.nixosModules.catppuccin + # if you use home-manager + home-manager.nixosModules.home-manager + + { + # if you use home-manager + home-manager.users.pepperjack = { + imports = [ + ./home.nix + catppuccin.homeManagerModules.catppuccin + ]; + }; + } + ]; + }; + + # for standalone home-manager installations + homeConfigurations.pepperjack = home-manager.lib.homeManagerConfiguration { + pkgs = nixpkgs.legacyPackages.x86_64-linux; + modules = [ + ./home.nix + catppuccin.homeManagerModules.catppuccin + ]; + }; + }; +} +```` diff --git a/docs/src/getting-started/stable-nix.md b/docs/src/getting-started/stable-nix.md new file mode 100644 index 0000000..5780f20 --- /dev/null +++ b/docs/src/getting-started/stable-nix.md @@ -0,0 +1,94 @@ +# Stable Nix + +When using stable Nix, we have a couple options for installing `catppuccin/nix` + +## With `npins` + +[`npins`](https://github.com/andir/npins) provides a way to easily ["pin"](https://nix.dev/tutorials/first-steps/towards-reproducibility-pinning-nixpkgs) and update external dependencies for your configurations. + +Assuming you have followed [their getting started guide](https://github.com/andir/npins#getting-started), you can run the following: + +```sh +npins add --name catppuccin github catppuccin nix +``` + +And in your system configuration: + +```nix +let + sources = import ./npins; +in +{ + imports = [ + (sources.catppuccin + "/modules/nixos") + ]; + + # if you use home-manager + home-manager.users.pepperjack = { + imports = [ + (sources.catppuccin + "/modules/home-manager") + ]; + }; +} +``` + +or if you use a [standalone installation](https://nix-community.github.io/home-manager/index.html#sec-install-standalone) of `home-manager` + +```nix +let + sources = import ./npins.nix; +in +{ + imports = [ + (sources.catppuccin + "/modules/home-manager") + ]; + + home.username = "pepperjack"; + programs.home-manager.enable = true; +} + +``` + +## With channels + +[Nix channels](https://nixos.org/manual/nix/stable/command-ref/nix-channel.html) provide a way for you to easily download, update, and use our modules -- though at the cost of reproducibility across machines. + +To add `catppuccin/nix` as a channel, you can run the following: + + +```sh +sudo nix-channel --add https://github.com/catppuccin/nix/archive/main.tar.gz catppuccin +sudo nix-channel --update +``` + +And in your system configuration: + +```nix +{ + imports = [ + + ]; + + # if you use home-manager + home-manager.users.pepperjack = { + imports = [ + + ]; + }; +} +``` + +or if you use a [standalone installation](https://nix-community.github.io/home-manager/index.html#sec-install-standalone) of `home-manager` + +```nix +{ + imports = [ + + ]; + + home.username = "pepperjack"; + programs.home-manager.enable = true; +} + +``` + diff --git a/docs/src/options/README.md b/docs/src/options/README.md new file mode 100644 index 0000000..fef2b9d --- /dev/null +++ b/docs/src/options/README.md @@ -0,0 +1,8 @@ +# Module Options + +Below is a (searchable) list of all the options in the modules we provide. Enjoy! + +- [NixOS options](nixos-options.md) +- [home-manager options](home-manager-options.md) + +If you have any issues with this documentation, don't hesitate to [open an issue](https://github.com/catppuccin/nix/issues/new). diff --git a/docs/theme/catppuccin.css b/docs/theme/catppuccin.css new file mode 100644 index 0000000..1ac8146 --- /dev/null +++ b/docs/theme/catppuccin.css @@ -0,0 +1,787 @@ +.mocha.hljs { + color: #cdd6f4; + background: #1e1e2e; +} +.mocha .hljs-keyword { + color: #cba6f7; +} +.mocha .hljs-built_in { + color: #f38ba8; +} +.mocha .hljs-type { + color: #f9e2af; +} +.mocha .hljs-literal { + color: #fab387; +} +.mocha .hljs-number { + color: #fab387; +} +.mocha .hljs-operator { + color: #94e2d5; +} +.mocha .hljs-punctuation { + color: #bac2de; +} +.mocha .hljs-property { + color: #94e2d5; +} +.mocha .hljs-regexp { + color: #f5c2e7; +} +.mocha .hljs-string { + color: #a6e3a1; +} +.mocha .hljs-char.escape_ { + color: #a6e3a1; +} +.mocha .hljs-subst { + color: #a6adc8; +} +.mocha .hljs-symbol { + color: #f2cdcd; +} +.mocha .hljs-variable { + color: #cba6f7; +} +.mocha .hljs-variable.language_ { + color: #cba6f7; +} +.mocha .hljs-variable.constant_ { + color: #fab387; +} +.mocha .hljs-title { + color: #89b4fa; +} +.mocha .hljs-title.class_ { + color: #f9e2af; +} +.mocha .hljs-title.function_ { + color: #89b4fa; +} +.mocha .hljs-params { + color: #cdd6f4; +} +.mocha .hljs-comment { + color: #585b70; +} +.mocha .hljs-doctag { + color: #f38ba8; +} +.mocha .hljs-meta { + color: #fab387; +} +.mocha .hljs-section { + color: #89b4fa; +} +.mocha .hljs-tag { + color: #a6adc8; +} +.mocha .hljs-name { + color: #cba6f7; +} +.mocha .hljs-attr { + color: #89b4fa; +} +.mocha .hljs-attribute { + color: #a6e3a1; +} +.mocha .hljs-bullet { + color: #94e2d5; +} +.mocha .hljs-code { + color: #a6e3a1; +} +.mocha .hljs-emphasis { + color: #f38ba8; + font-style: italic; +} +.mocha .hljs-strong { + color: #f38ba8; + font-weight: bold; +} +.mocha .hljs-formula { + color: #94e2d5; +} +.mocha .hljs-link { + color: #74c7ec; + font-style: italic; +} +.mocha .hljs-quote { + color: #a6e3a1; + font-style: italic; +} +.mocha .hljs-selector-tag { + color: #f9e2af; +} +.mocha .hljs-selector-id { + color: #89b4fa; +} +.mocha .hljs-selector-class { + color: #94e2d5; +} +.mocha .hljs-selector-attr { + color: #cba6f7; +} +.mocha .hljs-selector-pseudo { + color: #94e2d5; +} +.mocha .hljs-template-tag { + color: #f2cdcd; +} +.mocha .hljs-template-variable { + color: #f2cdcd; +} +.mocha .hljs-addition { + color: #a6e3a1; + background: rgba(166, 227, 161, 0.15); +} +.mocha .hljs-deletion { + color: #f38ba8; + background: rgba(243, 139, 168, 0.15); +} +.mocha code { + color: #cdd6f4; + background: #181825; +} +.mocha blockquote blockquote { + border-top: 0.1em solid #585b70; + border-bottom: 0.1em solid #585b70; +} +.mocha hr { + color: #585b70; +} +.mocha del { + color: #9399b2; +} +.mocha .ace_gutter { + color: #7f849c; + background: #181825; +} +.mocha .ace_gutter-active-line.ace_gutter-cell { + color: #f5c2e7; + background: #181825; +} + +.macchiato.hljs { + color: #cad3f5; + background: #24273a; +} +.macchiato .hljs-keyword { + color: #c6a0f6; +} +.macchiato .hljs-built_in { + color: #ed8796; +} +.macchiato .hljs-type { + color: #eed49f; +} +.macchiato .hljs-literal { + color: #f5a97f; +} +.macchiato .hljs-number { + color: #f5a97f; +} +.macchiato .hljs-operator { + color: #8bd5ca; +} +.macchiato .hljs-punctuation { + color: #b8c0e0; +} +.macchiato .hljs-property { + color: #8bd5ca; +} +.macchiato .hljs-regexp { + color: #f5bde6; +} +.macchiato .hljs-string { + color: #a6da95; +} +.macchiato .hljs-char.escape_ { + color: #a6da95; +} +.macchiato .hljs-subst { + color: #a5adcb; +} +.macchiato .hljs-symbol { + color: #f0c6c6; +} +.macchiato .hljs-variable { + color: #c6a0f6; +} +.macchiato .hljs-variable.language_ { + color: #c6a0f6; +} +.macchiato .hljs-variable.constant_ { + color: #f5a97f; +} +.macchiato .hljs-title { + color: #8aadf4; +} +.macchiato .hljs-title.class_ { + color: #eed49f; +} +.macchiato .hljs-title.function_ { + color: #8aadf4; +} +.macchiato .hljs-params { + color: #cad3f5; +} +.macchiato .hljs-comment { + color: #5b6078; +} +.macchiato .hljs-doctag { + color: #ed8796; +} +.macchiato .hljs-meta { + color: #f5a97f; +} +.macchiato .hljs-section { + color: #8aadf4; +} +.macchiato .hljs-tag { + color: #a5adcb; +} +.macchiato .hljs-name { + color: #c6a0f6; +} +.macchiato .hljs-attr { + color: #8aadf4; +} +.macchiato .hljs-attribute { + color: #a6da95; +} +.macchiato .hljs-bullet { + color: #8bd5ca; +} +.macchiato .hljs-code { + color: #a6da95; +} +.macchiato .hljs-emphasis { + color: #ed8796; + font-style: italic; +} +.macchiato .hljs-strong { + color: #ed8796; + font-weight: bold; +} +.macchiato .hljs-formula { + color: #8bd5ca; +} +.macchiato .hljs-link { + color: #7dc4e4; + font-style: italic; +} +.macchiato .hljs-quote { + color: #a6da95; + font-style: italic; +} +.macchiato .hljs-selector-tag { + color: #eed49f; +} +.macchiato .hljs-selector-id { + color: #8aadf4; +} +.macchiato .hljs-selector-class { + color: #8bd5ca; +} +.macchiato .hljs-selector-attr { + color: #c6a0f6; +} +.macchiato .hljs-selector-pseudo { + color: #8bd5ca; +} +.macchiato .hljs-template-tag { + color: #f0c6c6; +} +.macchiato .hljs-template-variable { + color: #f0c6c6; +} +.macchiato .hljs-addition { + color: #a6da95; + background: rgba(166, 218, 149, 0.15); +} +.macchiato .hljs-deletion { + color: #ed8796; + background: rgba(237, 135, 150, 0.15); +} +.macchiato code { + color: #cad3f5; + background: #1e2030; +} +.macchiato blockquote blockquote { + border-top: 0.1em solid #5b6078; + border-bottom: 0.1em solid #5b6078; +} +.macchiato hr { + color: #5b6078; +} +.macchiato del { + color: #939ab7; +} +.macchiato .ace_gutter { + color: #8087a2; + background: #1e2030; +} +.macchiato .ace_gutter-active-line.ace_gutter-cell { + color: #f5bde6; + background: #1e2030; +} + +.frappe.hljs { + color: #c6d0f5; + background: #303446; +} +.frappe .hljs-keyword { + color: #ca9ee6; +} +.frappe .hljs-built_in { + color: #e78284; +} +.frappe .hljs-type { + color: #e5c890; +} +.frappe .hljs-literal { + color: #ef9f76; +} +.frappe .hljs-number { + color: #ef9f76; +} +.frappe .hljs-operator { + color: #81c8be; +} +.frappe .hljs-punctuation { + color: #b5bfe2; +} +.frappe .hljs-property { + color: #81c8be; +} +.frappe .hljs-regexp { + color: #f4b8e4; +} +.frappe .hljs-string { + color: #a6d189; +} +.frappe .hljs-char.escape_ { + color: #a6d189; +} +.frappe .hljs-subst { + color: #a5adce; +} +.frappe .hljs-symbol { + color: #eebebe; +} +.frappe .hljs-variable { + color: #ca9ee6; +} +.frappe .hljs-variable.language_ { + color: #ca9ee6; +} +.frappe .hljs-variable.constant_ { + color: #ef9f76; +} +.frappe .hljs-title { + color: #8caaee; +} +.frappe .hljs-title.class_ { + color: #e5c890; +} +.frappe .hljs-title.function_ { + color: #8caaee; +} +.frappe .hljs-params { + color: #c6d0f5; +} +.frappe .hljs-comment { + color: #626880; +} +.frappe .hljs-doctag { + color: #e78284; +} +.frappe .hljs-meta { + color: #ef9f76; +} +.frappe .hljs-section { + color: #8caaee; +} +.frappe .hljs-tag { + color: #a5adce; +} +.frappe .hljs-name { + color: #ca9ee6; +} +.frappe .hljs-attr { + color: #8caaee; +} +.frappe .hljs-attribute { + color: #a6d189; +} +.frappe .hljs-bullet { + color: #81c8be; +} +.frappe .hljs-code { + color: #a6d189; +} +.frappe .hljs-emphasis { + color: #e78284; + font-style: italic; +} +.frappe .hljs-strong { + color: #e78284; + font-weight: bold; +} +.frappe .hljs-formula { + color: #81c8be; +} +.frappe .hljs-link { + color: #85c1dc; + font-style: italic; +} +.frappe .hljs-quote { + color: #a6d189; + font-style: italic; +} +.frappe .hljs-selector-tag { + color: #e5c890; +} +.frappe .hljs-selector-id { + color: #8caaee; +} +.frappe .hljs-selector-class { + color: #81c8be; +} +.frappe .hljs-selector-attr { + color: #ca9ee6; +} +.frappe .hljs-selector-pseudo { + color: #81c8be; +} +.frappe .hljs-template-tag { + color: #eebebe; +} +.frappe .hljs-template-variable { + color: #eebebe; +} +.frappe .hljs-addition { + color: #a6d189; + background: rgba(166, 209, 137, 0.15); +} +.frappe .hljs-deletion { + color: #e78284; + background: rgba(231, 130, 132, 0.15); +} +.frappe code { + color: #c6d0f5; + background: #292c3c; +} +.frappe blockquote blockquote { + border-top: 0.1em solid #626880; + border-bottom: 0.1em solid #626880; +} +.frappe hr { + color: #626880; +} +.frappe del { + color: #949cbb; +} +.frappe .ace_gutter { + color: #838ba7; + background: #292c3c; +} +.frappe .ace_gutter-active-line.ace_gutter-cell { + color: #f4b8e4; + background: #292c3c; +} + +.latte.hljs { + color: #4c4f69; + background: #eff1f5; +} +.latte .hljs-keyword { + color: #8839ef; +} +.latte .hljs-built_in { + color: #d20f39; +} +.latte .hljs-type { + color: #df8e1d; +} +.latte .hljs-literal { + color: #fe640b; +} +.latte .hljs-number { + color: #fe640b; +} +.latte .hljs-operator { + color: #179299; +} +.latte .hljs-punctuation { + color: #5c5f77; +} +.latte .hljs-property { + color: #179299; +} +.latte .hljs-regexp { + color: #ea76cb; +} +.latte .hljs-string { + color: #40a02b; +} +.latte .hljs-char.escape_ { + color: #40a02b; +} +.latte .hljs-subst { + color: #6c6f85; +} +.latte .hljs-symbol { + color: #dd7878; +} +.latte .hljs-variable { + color: #8839ef; +} +.latte .hljs-variable.language_ { + color: #8839ef; +} +.latte .hljs-variable.constant_ { + color: #fe640b; +} +.latte .hljs-title { + color: #1e66f5; +} +.latte .hljs-title.class_ { + color: #df8e1d; +} +.latte .hljs-title.function_ { + color: #1e66f5; +} +.latte .hljs-params { + color: #4c4f69; +} +.latte .hljs-comment { + color: #acb0be; +} +.latte .hljs-doctag { + color: #d20f39; +} +.latte .hljs-meta { + color: #fe640b; +} +.latte .hljs-section { + color: #1e66f5; +} +.latte .hljs-tag { + color: #6c6f85; +} +.latte .hljs-name { + color: #8839ef; +} +.latte .hljs-attr { + color: #1e66f5; +} +.latte .hljs-attribute { + color: #40a02b; +} +.latte .hljs-bullet { + color: #179299; +} +.latte .hljs-code { + color: #40a02b; +} +.latte .hljs-emphasis { + color: #d20f39; + font-style: italic; +} +.latte .hljs-strong { + color: #d20f39; + font-weight: bold; +} +.latte .hljs-formula { + color: #179299; +} +.latte .hljs-link { + color: #209fb5; + font-style: italic; +} +.latte .hljs-quote { + color: #40a02b; + font-style: italic; +} +.latte .hljs-selector-tag { + color: #df8e1d; +} +.latte .hljs-selector-id { + color: #1e66f5; +} +.latte .hljs-selector-class { + color: #179299; +} +.latte .hljs-selector-attr { + color: #8839ef; +} +.latte .hljs-selector-pseudo { + color: #179299; +} +.latte .hljs-template-tag { + color: #dd7878; +} +.latte .hljs-template-variable { + color: #dd7878; +} +.latte .hljs-addition { + color: #40a02b; + background: rgba(64, 160, 43, 0.15); +} +.latte .hljs-deletion { + color: #d20f39; + background: rgba(210, 15, 57, 0.15); +} +.latte code { + color: #4c4f69; + background: #e6e9ef; +} +.latte blockquote blockquote { + border-top: 0.1em solid #acb0be; + border-bottom: 0.1em solid #acb0be; +} +.latte hr { + color: #acb0be; +} +.latte del { + color: #7c7f93; +} +.latte .ace_gutter { + color: #8c8fa1; + background: #e6e9ef; +} +.latte .ace_gutter-active-line.ace_gutter-cell { + color: #ea76cb; + background: #e6e9ef; +} + +.mocha { + --bg: #1e1e2e; + --fg: #cdd6f4; + --sidebar-bg: #181825; + --sidebar-fg: #cdd6f4; + --sidebar-non-existant: #6c7086; + --sidebar-active: #89b4fa; + --sidebar-spacer: #6c7086; + --scrollbar: #6c7086; + --icons: #6c7086; + --icons-hover: #7f849c; + --links: #89b4fa; + --inline-code-color: #fab387; + --theme-popup-bg: #181825; + --theme-popup-border: #6c7086; + --theme-hover: #6c7086; + --quote-bg: #181825; + --quote-border: #11111b; + --table-border-color: #11111b; + --table-header-bg: #181825; + --table-alternate-bg: #181825; + --searchbar-border-color: #11111b; + --searchbar-bg: #181825; + --searchbar-fg: #cdd6f4; + --searchbar-shadow-color: #11111b; + --searchresults-header-fg: #cdd6f4; + --searchresults-border-color: #11111b; + --searchresults-li-bg: #1e1e2e; + --search-mark-bg: #fab387; + --warning-border: #fab387; +} + +.macchiato { + --bg: #24273a; + --fg: #cad3f5; + --sidebar-bg: #1e2030; + --sidebar-fg: #cad3f5; + --sidebar-non-existant: #6e738d; + --sidebar-active: #8aadf4; + --sidebar-spacer: #6e738d; + --scrollbar: #6e738d; + --icons: #6e738d; + --icons-hover: #8087a2; + --links: #8aadf4; + --inline-code-color: #f5a97f; + --theme-popup-bg: #1e2030; + --theme-popup-border: #6e738d; + --theme-hover: #6e738d; + --quote-bg: #1e2030; + --quote-border: #181926; + --table-border-color: #181926; + --table-header-bg: #1e2030; + --table-alternate-bg: #1e2030; + --searchbar-border-color: #181926; + --searchbar-bg: #1e2030; + --searchbar-fg: #cad3f5; + --searchbar-shadow-color: #181926; + --searchresults-header-fg: #cad3f5; + --searchresults-border-color: #181926; + --searchresults-li-bg: #24273a; + --search-mark-bg: #f5a97f; + --warning-border: #f5a97f; +} + +.frappe { + --bg: #303446; + --fg: #c6d0f5; + --sidebar-bg: #292c3c; + --sidebar-fg: #c6d0f5; + --sidebar-non-existant: #737994; + --sidebar-active: #8caaee; + --sidebar-spacer: #737994; + --scrollbar: #737994; + --icons: #737994; + --icons-hover: #838ba7; + --links: #8caaee; + --inline-code-color: #ef9f76; + --theme-popup-bg: #292c3c; + --theme-popup-border: #737994; + --theme-hover: #737994; + --quote-bg: #292c3c; + --quote-border: #232634; + --table-border-color: #232634; + --table-header-bg: #292c3c; + --table-alternate-bg: #292c3c; + --searchbar-border-color: #232634; + --searchbar-bg: #292c3c; + --searchbar-fg: #c6d0f5; + --searchbar-shadow-color: #232634; + --searchresults-header-fg: #c6d0f5; + --searchresults-border-color: #232634; + --searchresults-li-bg: #303446; + --search-mark-bg: #ef9f76; + --warning-border: #ef9f76; +} + +.latte { + --bg: #eff1f5; + --fg: #4c4f69; + --sidebar-bg: #e6e9ef; + --sidebar-fg: #4c4f69; + --sidebar-non-existant: #9ca0b0; + --sidebar-active: #1e66f5; + --sidebar-spacer: #9ca0b0; + --scrollbar: #9ca0b0; + --icons: #9ca0b0; + --icons-hover: #8c8fa1; + --links: #1e66f5; + --inline-code-color: #fe640b; + --theme-popup-bg: #e6e9ef; + --theme-popup-border: #9ca0b0; + --theme-hover: #9ca0b0; + --quote-bg: #e6e9ef; + --quote-border: #dce0e8; + --table-border-color: #dce0e8; + --table-header-bg: #e6e9ef; + --table-alternate-bg: #e6e9ef; + --searchbar-border-color: #dce0e8; + --searchbar-bg: #e6e9ef; + --searchbar-fg: #4c4f69; + --searchbar-shadow-color: #dce0e8; + --searchresults-header-fg: #4c4f69; + --searchresults-border-color: #dce0e8; + --searchresults-li-bg: #eff1f5; + --search-mark-bg: #fe640b; + --warning-border: #fe640b; +} diff --git a/docs/theme/index.hbs b/docs/theme/index.hbs new file mode 100644 index 0000000..bbf5d11 --- /dev/null +++ b/docs/theme/index.hbs @@ -0,0 +1,348 @@ + + + + + + {{ title }} + {{#if is_print }} + + {{/if}} + {{#if base_url}} + + {{/if}} + + + + {{> head}} + + + + + + {{#if favicon_svg}} + + {{/if}} + {{#if favicon_png}} + + {{/if}} + + + + {{#if print_enable}} + + {{/if}} + + + + {{#if copy_fonts}} + + {{/if}} + + + + + + + + {{#each additional_css}} + + {{/each}} + + {{#if mathjax_support}} + + + {{/if}} + + +
+ + + + + + + + + + + + + + + + + + + +
+ +
+ {{> header}} + + + + {{#if search_enabled}} + + {{/if}} + + + + +
+
+ {{{ content }}} +
+ + +
+
+ + + +
+ + {{#if live_reload_endpoint}} + + + {{/if}} + + {{#if google_analytics}} + + + {{/if}} + + {{#if playground_line_numbers}} + + {{/if}} + + {{#if playground_copyable}} + + {{/if}} + + {{#if playground_js}} + + + + + + {{/if}} + + {{#if search_js}} + + + + {{/if}} + + + + + + + {{#each additional_js}} + + {{/each}} + + {{#if is_print}} + {{#if mathjax_support}} + + {{else}} + + {{/if}} + {{/if}} + +
+ + \ No newline at end of file