Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add missing Catppuccin Palettes #4

Merged
merged 12 commits into from
Sep 15, 2024
Prev Previous commit
Next Next commit
docs: update notes
  • Loading branch information
pivoshenko committed Sep 15, 2024
commit 844ffb22c3e4704de42326e30d8bfbabcca0dca1
13 changes: 12 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,12 @@ https://github.com/pivoshenko/catppuccin-startpage/assets/40499728/d96c8bd6-168e
> [!NOTE]
> A live demo can be found [here](https://pivoshenko.github.io/catppuccin-startpage)

> [!CAUTION]
> Currently, I am doing some refactoring, so README will look way better and closer to the standard Catppuccin project

## Overview

Aesthetic and clean startpage in [**Catppuccin Mocha**](https://catppuccin.com/palette) style, hosted on GitHub Pages. This start page is based on the [`dawn`](https://github.com/b-coimbra/dawn) and [`tartarus-startpage`](https://github.com/AllJavi/tartarus-startpage), which has even more functionality.
Aesthetic and clean startpage in [**Catppuccin**](https://catppuccin.com/palette) style, hosted on GitHub Pages. This start page is based on the [`dawn`](https://github.com/b-coimbra/dawn) and [`tartarus-startpage`](https://github.com/AllJavi/tartarus-startpage), which has even more functionality.
I've tweaked the page's style to match [Catppuccin](https://github.com/catppuccin/catppuccin) palette and my [`dotfiles`](https://github.com/pivoshenko/dotfiles).

### Main principles
Expand All @@ -35,13 +38,21 @@ I've tweaked the page's style to match [Catppuccin](https://github.com/catppucci
- One style
- Reduced visual noise

### Supported Palettes

- Latte
- Frappé
- Macchiato
- Mocha

## Usage

1. Fork this repository and clone it

2. Remove `.github` directory as it contains only PR templates, issue labels etc that are linked to this repository

3. Update [`userconfig.js`](userconfig.js):
- Set the desired palette: `latte / frappe / macchiato / mocha`
- Set your location for the weather widget
- Update the number of pages and their banners
- Update bookmarks and quick links for the one you are using the most :3
Expand Down