From bc20814bc6f84e9981040882d4d590664cf91c7f Mon Sep 17 00:00:00 2001 From: sgoudham Date: Sun, 6 Oct 2024 18:57:00 +0100 Subject: [PATCH] docs: restructure --- README.md | 34 ++++++++++++++++++---------------- build.ts | 20 ++++++++++---------- 2 files changed, 28 insertions(+), 26 deletions(-) diff --git a/README.md b/README.md index 6e8f0a9..5eab747 100644 --- a/README.md +++ b/README.md @@ -43,37 +43,39 @@ 2. Place the CSS files inside Gitea's configuration directory: - Gitea 1.21.0 or newer: `$GITEA_CUSTOM/public/assets/css` - Otherwise: `$GITEA_CUSTOM/public/css` -3. Add the themes to your `app.ini`. See the [Gitea documentation](https://docs.gitea.io/en-us/customizing-gitea/#customizing-the-look-of-gitea). +3. Add the themes to your `app.ini` as shown in the "[Example + Configurations](#example-configurations)" section. For further information on customizing Gitea, see the [Gitea documentation](https://docs.gitea.com/next/administration/customizing-gitea#customizing-the-look-of-gitea). +4. Restart your Gitea instance. +5. Select the theme in Gitea > Account > Settings > Appearance. - Here's a snippet if you want to offer all flavor-accent combinations: +### Example Configurations + +#### Flavor-Accent - ```ini - [ui] - THEMES = catppuccin-latte-rosewater,catppuccin-latte-flamingo,catppuccin-latte-pink,catppuccin-latte-mauve,catppuccin-latte-red,catppuccin-latte-maroon,catppuccin-latte-peach,catppuccin-latte-yellow,catppuccin-latte-green,catppuccin-latte-teal,catppuccin-latte-sky,catppuccin-latte-sapphire,catppuccin-latte-blue,catppuccin-latte-lavender,catppuccin-frappe-rosewater,catppuccin-frappe-flamingo,catppuccin-frappe-pink,catppuccin-frappe-mauve,catppuccin-frappe-red,catppuccin-frappe-maroon,catppuccin-frappe-peach,catppuccin-frappe-yellow,catppuccin-frappe-green,catppuccin-frappe-teal,catppuccin-frappe-sky,catppuccin-frappe-sapphire,catppuccin-frappe-blue,catppuccin-frappe-lavender,catppuccin-macchiato-rosewater,catppuccin-macchiato-flamingo,catppuccin-macchiato-pink,catppuccin-macchiato-mauve,catppuccin-macchiato-red,catppuccin-macchiato-maroon,catppuccin-macchiato-peach,catppuccin-macchiato-yellow,catppuccin-macchiato-green,catppuccin-macchiato-teal,catppuccin-macchiato-sky,catppuccin-macchiato-sapphire,catppuccin-macchiato-blue,catppuccin-macchiato-lavender,catppuccin-mocha-rosewater,catppuccin-mocha-flamingo,catppuccin-mocha-pink,catppuccin-mocha-mauve,catppuccin-mocha-red,catppuccin-mocha-maroon,catppuccin-mocha-peach,catppuccin-mocha-yellow,catppuccin-mocha-green,catppuccin-mocha-teal,catppuccin-mocha-sky,catppuccin-mocha-sapphire,catppuccin-mocha-blue,catppuccin-mocha-lavender - ``` +```ini +[ui] +THEMES = catppuccin-latte-rosewater,catppuccin-latte-flamingo,catppuccin-latte-pink,catppuccin-latte-mauve,catppuccin-latte-red,catppuccin-latte-maroon,catppuccin-latte-peach,catppuccin-latte-yellow,catppuccin-latte-green,catppuccin-latte-teal,catppuccin-latte-sky,catppuccin-latte-sapphire,catppuccin-latte-blue,catppuccin-latte-lavender,catppuccin-frappe-rosewater,catppuccin-frappe-flamingo,catppuccin-frappe-pink,catppuccin-frappe-mauve,catppuccin-frappe-red,catppuccin-frappe-maroon,catppuccin-frappe-peach,catppuccin-frappe-yellow,catppuccin-frappe-green,catppuccin-frappe-teal,catppuccin-frappe-sky,catppuccin-frappe-sapphire,catppuccin-frappe-blue,catppuccin-frappe-lavender,catppuccin-macchiato-rosewater,catppuccin-macchiato-flamingo,catppuccin-macchiato-pink,catppuccin-macchiato-mauve,catppuccin-macchiato-red,catppuccin-macchiato-maroon,catppuccin-macchiato-peach,catppuccin-macchiato-yellow,catppuccin-macchiato-green,catppuccin-macchiato-teal,catppuccin-macchiato-sky,catppuccin-macchiato-sapphire,catppuccin-macchiato-blue,catppuccin-macchiato-lavender,catppuccin-mocha-rosewater,catppuccin-mocha-flamingo,catppuccin-mocha-pink,catppuccin-mocha-mauve,catppuccin-mocha-red,catppuccin-mocha-maroon,catppuccin-mocha-peach,catppuccin-mocha-yellow,catppuccin-mocha-green,catppuccin-mocha-teal,catppuccin-mocha-sky,catppuccin-mocha-sapphire,catppuccin-mocha-blue,catppuccin-mocha-lavender +``` - Additionally or alternatively, you add the `auto` versions which ensure - that the theme automatically switches between light (latte) and dark (mocha) - mode: +#### Auto + +This ensures that the theme automatically switches between light (latte) and dark (mocha) mode. - ```ini - [ui] - THEMES = catppuccin-rosewater-auto,catppuccin-flamingo-auto,catppuccin-pink-auto,catppuccin-mauve-auto,catppuccin-red-auto,catppuccin-maroon-auto,catppuccin-peach-auto,catppuccin-yellow-auto,catppuccin-green-auto,catppuccin-teal-auto,catppuccin-sky-auto,catppuccin-sapphire-auto,catppuccin-blue-auto,catppuccin-lavender-auto - ``` +```ini +[ui] +THEMES = catppuccin-rosewater-auto,catppuccin-flamingo-auto,catppuccin-pink-auto,catppuccin-mauve-auto,catppuccin-red-auto,catppuccin-maroon-auto,catppuccin-peach-auto,catppuccin-yellow-auto,catppuccin-green-auto,catppuccin-teal-auto,catppuccin-sky-auto,catppuccin-sapphire-auto,catppuccin-blue-auto,catppuccin-lavender-auto +``` -4. Restart your Gitea instance. -5. Select the theme in Gitea > Account > Settings > Appearance. - ## 💝 Thanks to - [winston](https://github.com/nekowinston) diff --git a/build.ts b/build.ts index fe878b4..5e2ee53 100755 --- a/build.ts +++ b/build.ts @@ -44,19 +44,19 @@ for (const accent of accents) { } const flavorAccentIni = ` - \`\`\`ini - [ui] - THEMES = ${flavors - .map((f) => accents.map((a) => `catppuccin-${f}-${a}`).join(",")) - .join(",")} - \`\`\` +\`\`\`ini +[ui] +THEMES = ${flavors + .map((f) => accents.map((a) => `catppuccin-${f}-${a}`).join(",")) + .join(",")} +\`\`\` `; const themeAutoIni = ` - \`\`\`ini - [ui] - THEMES = ${accents.map((a) => `catppuccin-${a}-auto`).join(",")} - \`\`\` +\`\`\`ini +[ui] +THEMES = ${accents.map((a) => `catppuccin-${a}-auto`).join(",")} +\`\`\` `; const oldReadme = Deno.readTextFileSync(path.join(__dirname, "README.md"));