From d10f8b3ebe73445b4a0a3c1eec241e09521ffd86 Mon Sep 17 00:00:00 2001 From: seth Date: Mon, 13 May 2024 23:29:41 -0400 Subject: [PATCH] feat: flesh out docs site --- .editorconfig | 4 + README.md | 47 +- dev/flake.lock | 21 - dev/flake.nix | 9 +- docs/book.toml | 1 + docs/mk-site.nix | 17 +- docs/src/CONTRIBUTING.md | 5 + docs/src/README.md | 17 +- docs/src/SUMMARY.md | 8 + docs/src/faq.md | 8 + docs/src/getting-started/README.md | 6 + docs/src/getting-started/flakes.md | 100 ++++ docs/src/getting-started/stable-nix.md | 94 +++ docs/src/options/README.md | 4 + docs/theme/catppuccin.css | 787 +++++++++++++++++++++++++ docs/theme/index.hbs | 348 +++++++++++ 16 files changed, 1417 insertions(+), 59 deletions(-) create mode 100644 docs/src/CONTRIBUTING.md create mode 100644 docs/src/faq.md create mode 100644 docs/src/getting-started/README.md create mode 100644 docs/src/getting-started/flakes.md create mode 100644 docs/src/getting-started/stable-nix.md create mode 100644 docs/theme/catppuccin.css create mode 100644 docs/theme/index.hbs diff --git a/.editorconfig b/.editorconfig index d86ac027..be84ee6f 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/README.md b/README.md index 96ad60db..90cdd41d 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) ## 💝 Thanks to diff --git a/dev/flake.lock b/dev/flake.lock index a28fe4ab..2e37441d 100644 --- a/dev/flake.lock +++ b/dev/flake.lock @@ -20,26 +20,6 @@ "type": "github" } }, - "mdbook": { - "inputs": { - "nixpkgs": [ - "nixpkgs" - ] - }, - "locked": { - "lastModified": 1707626069, - "narHash": "sha256-4K7a5qdvSKBtNnp+7Ya+G63aQQGpFdNSRWXQeCvlU98=", - "owner": "catppuccin", - "repo": "mdbook", - "rev": "9b436bf09bec634bf797a0b363249c718b6fa332", - "type": "github" - }, - "original": { - "owner": "catppuccin", - "repo": "mdbook", - "type": "github" - } - }, "nixpkgs": { "locked": { "lastModified": 1715534503, @@ -58,7 +38,6 @@ "root": { "inputs": { "home-manager": "home-manager", - "mdbook": "mdbook", "nixpkgs": "nixpkgs" } } diff --git a/dev/flake.nix b/dev/flake.nix index ecf57584..22661c1a 100644 --- a/dev/flake.nix +++ b/dev/flake.nix @@ -8,14 +8,9 @@ url = "github:nix-community/home-manager"; inputs.nixpkgs.follows = "nixpkgs"; }; - - mdbook = { - url = "github:catppuccin/mdbook"; - inputs.nixpkgs.follows = "nixpkgs"; - }; }; - outputs = { self, nixpkgs, home-manager, mdbook }: + outputs = { self, nixpkgs, home-manager }: let systems = [ "x86_64-linux" @@ -60,7 +55,7 @@ let version = self.shortRev or self.dirtyShortRev or "unknown"; mkOptionDoc = pkgs.callPackage ../docs/options-doc.nix { }; - mkSite = pkgs.callPackage ../docs/mk-site.nix { inherit (mdbook.packages.${system}) mdbook-catppuccin; }; + mkSite = pkgs.callPackage ../docs/mk-site.nix { }; packages' = self.packages.${system}; in { diff --git a/docs/book.toml b/docs/book.toml index a5704042..09cb7ebd 100644 --- a/docs/book.toml +++ b/docs/book.toml @@ -9,6 +9,7 @@ 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" diff --git a/docs/mk-site.nix b/docs/mk-site.nix index 72b8efa2..a888c671 100644 --- a/docs/mk-site.nix +++ b/docs/mk-site.nix @@ -2,8 +2,7 @@ , stdenvNoCC , writeShellApplication , mdbook -, mdbook-catppuccin -, simple-http-server +, python3 }: { nixosDoc , homeManagerDoc , ... @@ -11,20 +10,12 @@ stdenvNoCC.mkDerivation (finalAttrs: args // { nativeBuildInputs = [ mdbook - mdbook-catppuccin ]; dontPatch = true; + dontConfigure = true; doCheck = false; - configurePhase = '' - runHook preConfigure - - mdbook-catppuccin install - - runHook postConfigure - ''; - buildPhase = '' runHook preBuild @@ -47,10 +38,10 @@ stdenvNoCC.mkDerivation (finalAttrs: args // { serve = writeShellApplication { name = "serve"; - runtimeInputs = [ simple-http-server ]; + runtimeInputs = [ python3 ]; text = '' - simple-http-server --index --ip 127.0.0.1 ${finalAttrs.finalPackage} + python -m http.server --bind 127.0.0.1 --directory ${finalAttrs.finalPackage} ''; }; }; diff --git a/docs/src/CONTRIBUTING.md b/docs/src/CONTRIBUTING.md new file mode 100644 index 00000000..debc754f --- /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/README.md b/docs/src/README.md index 5a9c4bf6..e5f763c4 100644 --- a/docs/src/README.md +++ b/docs/src/README.md @@ -1,3 +1,16 @@ -# Hello world! +# catppuccin/nix -TODO +*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 index 7d7cc758..39d75d7b 100644 --- a/docs/src/SUMMARY.md +++ b/docs/src/SUMMARY.md @@ -2,6 +2,14 @@ [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) + +- [Contributing](CONTRIBUTING.md) diff --git a/docs/src/faq.md b/docs/src/faq.md new file mode 100644 index 00000000..401ad802 --- /dev/null +++ b/docs/src/faq.md @@ -0,0 +1,8 @@ +# 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) diff --git a/docs/src/getting-started/README.md b/docs/src/getting-started/README.md new file mode 100644 index 00000000..2e6db29a --- /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 00000000..c78eb5c8 --- /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 00000000..a873e02f --- /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 --name +``` + +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 index 6376ce8c..fef2b9d4 100644 --- a/docs/src/options/README.md +++ b/docs/src/options/README.md @@ -1,4 +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 00000000..1ac81462 --- /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 00000000..bbf5d115 --- /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