Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
60 commits
Select commit Hold shift + click to select a range
aa04c4f
feat: migrate docs to Starlight
trueberryless Aug 29, 2025
344e88d
fix: switch to pnpm because deno Astro support not great
trueberryless Aug 29, 2025
af55f53
chore: add support for custom heading ids
trueberryless Aug 29, 2025
46c588f
chore: clean up styles, adopt to me more like whiskers
trueberryless Aug 29, 2025
1325b56
chore: improve description and tagline
trueberryless Aug 29, 2025
6144ecd
chore: remove contributor list
trueberryless Aug 29, 2025
efbcaf3
chore: make structure more similar to whiskers
trueberryless Aug 29, 2025
a718851
chore: fix index image
trueberryless Aug 29, 2025
79a2f62
chore: add descriptions to all pages
trueberryless Aug 29, 2025
287837a
Update docs/astro.config.mjs
trueberryless Aug 29, 2025
c5af1b2
Update docs/src/content/docs/getting-started/USAGE.md
trueberryless Aug 29, 2025
ead71e8
Update docs/src/content/docs/getting-started/FAQ.md
trueberryless Aug 29, 2025
24d0b56
Update docs/src/content/docs/userstyle-creation/tips-and-tricks/see-c…
trueberryless Aug 29, 2025
b1a8abd
Update docs/src/content/docs/index.mdx
trueberryless Aug 29, 2025
6998bac
Update docs/src/content/docs/index.mdx
trueberryless Aug 29, 2025
d083c55
Update docs/src/content/docs/guides/userstylesyml.md
trueberryless Aug 29, 2025
e72b5bd
chore: remove website deployment and create docs workflow
trueberryless Aug 29, 2025
28d4dfa
revert: images back to webp format
trueberryless Aug 29, 2025
9ce18fa
fix: invalid slug in sidebar
trueberryless Aug 29, 2025
569d120
refactor: rename to hot-reloading
trueberryless Aug 29, 2025
18d994b
chore: create CNAME file for custom domain
trueberryless Aug 29, 2025
1723f4c
Update docs/src/content/docs/userstyle-creation/tips-and-tricks/hot-r…
trueberryless Aug 29, 2025
d0a717d
Update docs/src/content/docs/userstyle-creation/tips-and-tricks/hot-r…
trueberryless Aug 29, 2025
471e1d0
Update docs/src/content/docs/userstyle-creation/tips-and-tricks/hot-r…
trueberryless Aug 29, 2025
56a793b
docs(tutorials/writing-a-userstyle.md): add alt text to images
WalkQuackBack Aug 29, 2025
9d7b5d4
Update docs/src/content/docs/userstyle-creation/tutorials/writing-a-u…
trueberryless Aug 29, 2025
fc486fd
Update .github/workflows/docs.yml
trueberryless Aug 29, 2025
818b086
fix: overview problem
trueberryless Aug 29, 2025
c40cf66
fix: all internal links now valid (exclude autogenerated)
trueberryless Aug 29, 2025
a0ff817
feat: ports integration
trueberryless Aug 29, 2025
e5c0e51
feat: add mermaid integration
trueberryless Aug 30, 2025
0f9e44f
feat: card implementation
trueberryless Aug 30, 2025
b686b5e
feat: use category data and AnchorHeading Starlight component
trueberryless Aug 30, 2025
d01cc85
Update docs/src/content/docs/guides/CONTRIBUTING.md
trueberryless Aug 30, 2025
cfa8e23
Update docs/src/pages/ports/[slug].astro
trueberryless Aug 30, 2025
78938e7
Update docs/src/pages/ports/[slug].astro
trueberryless Aug 30, 2025
9b6e036
feat(lib): add lib.less standard library (#1843)
uncenter Aug 29, 2025
9b6efd7
fix(twitch): dashboard elements (#1855)
mxgic1337 Aug 30, 2025
39b7592
chore: bump changed userstyles
github-actions[bot] Aug 30, 2025
d2b671f
feat: add symlink to access /lib/lib.less on website
trueberryless Aug 30, 2025
6008526
Merge branch 'main' into feature/starlight-docs
trueberryless Aug 30, 2025
f39d484
fix: use slug for heading ids
trueberryless Aug 30, 2025
c30a922
chore(pnpm): allow build scripts
uncenter Aug 30, 2025
d25ae92
docs(README.md): direct users to website
uncenter Aug 30, 2025
fe0f6c0
docs: remove per userstyle pages, simplify types and headings
uncenter Aug 30, 2025
a17f0c2
docs: move userstyles list to introduction as simple list without car…
uncenter Aug 30, 2025
1cd8912
refactor: type import
uncenter Aug 31, 2025
ad21eae
Merge pull request #1 from catppuccin/docs/starlight-simple-userstyle…
trueberryless Aug 31, 2025
927a7d6
fix(scripts/generate): update userstyle readme template to link to we…
uncenter Aug 31, 2025
81315f3
refactor(docs): move mdx imports
uncenter Aug 31, 2025
6005075
docs: remove starlight links validator exclusion
uncenter Aug 31, 2025
3ff9a67
docs: description wording
uncenter Aug 31, 2025
6274d97
docs: restructure contributing, new reference section
uncenter Aug 31, 2025
3de1421
refactor: please the linter
uncenter Aug 31, 2025
31f0d16
docs: remove bluesky social link
uncenter Aug 31, 2025
0005cae
docs: rename "userstyle creation" to "creating userstyles"
uncenter Aug 31, 2025
98f9c24
docs: contributing/guides/index description
uncenter Aug 31, 2025
6f1d5ca
docs: use starlight steps component for lists
uncenter Aug 31, 2025
0feb086
refactor(userstylesyml): add steps component
sgoudham Aug 31, 2025
b0415bf
Update README.md
sgoudham Aug 31, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Deploy Docs to GH Pages

on:
push:
branches: [main]
paths:
- 'docs/**'
workflow_dispatch:

permissions:
contents: read
pages: write
id-token: write

jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v5
- name: Build & Upload Site
uses: withastro/action@v4
with:
path: ./docs
package-manager: [email protected]

deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
20 changes: 0 additions & 20 deletions .github/workflows/website.yml

This file was deleted.

269 changes: 4 additions & 265 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,6 @@
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/misc/transparent.png" height="30" width="0px"/>
</h3>

<p align="center">
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/palette/macchiato.png" width="400" />
</p>

<p align="center">
<a href="https://github.com/catppuccin/userstyles/stargazers"><img src="https://img.shields.io/github/stars/catppuccin/userstyles?colorA=363a4f&colorB=b7bdf8&style=for-the-badge"></a>
<a href="https://github.com/catppuccin/userstyles/blob/main/styles"><img src="https://img.shields.io/github/directory-file-count/catppuccin/userstyles/styles?label=Userstyles&colorA=363a4f&colorB=cba6f7&style=for-the-badge"></a>
Expand All @@ -21,269 +17,12 @@ A curated collection of soothing pastel themes for your favorite websites and we
</p>

<p align="center">
<img src="docs/images/preview.webp"/>
<img src="docs/src/assets/preview.webp"/>
</p>

## Getting started

To get started using the catppuccin/userstyles collection, see [Usage](docs/USAGE.md).

To get started contributing to catppuccin/userstyles, see [Contributing](docs/CONTRIBUTING.md) and [Userstyle Creation](docs/userstyle-creation.md).

## 🖌 Userstyles

> [!IMPORTANT]
> Userstyles labeled with the "❤️‍🩹" emoji lack maintainers, and may not work as intended. Contributions are still welcome and encouraged!

<!-- AUTOGEN:USERSTYLES START -->
<!-- The following section is auto-generated, do not edit. -->
<details open>
<summary>💭 Development Tools</summary>

- [boringproxy](styles/boringproxy)
- [Codeberg](styles/codeberg)
- [DevDocs](styles/devdocs)
- [docs.deno.com](styles/docs.deno.com)
- [docs.rs](styles/docs.rs)
- [freedesktop.org](styles/freedesktop)
- [GitHub](styles/github)
- [gleam.run](styles/gleam.run)
- [go.dev](styles/go.dev)
- [Grabify](styles/grabify)
- ❤️‍🩹 [Graphite](styles/graphite)
- [Home Manager Options Search](styles/home-manager-options-search)
- [Hoogle](styles/hoogle)
- [Hoppscotch](styles/hoppscotch)
- [Keyoxide](styles/keyoxide)
- [Learn X in Y Minutes](styles/learn-x-in-y-minutes)
- [MDN](styles/mdn)
- [Next.js](styles/vercel)
- [NixOS Manual](styles/nixos-manual)
- [Nixpkgs Manual](styles/nixos-manual)
- [paste.rs](styles/paste.rs)
- [PythonAnywhere](styles/pythonanywhere)
- [React.dev](styles/react.dev)
- [Trinket](styles/trinket)
- [Vercel](styles/vercel)
- [web.dev](styles/web.dev)

</details>
<details open>
<summary>📜 Documentation Generators</summary>

- [mdBook](styles/mdbook)

</details>
<details open>
<summary>🌱 Terminals</summary>

- [Ghostty.org](styles/ghostty.org)

</details>
<details open>
<summary>🗂️ File Managers</summary>

- [openmediavault](styles/openmediavault)
- [Syncthing](styles/syncthing)

</details>
<details open>
<summary>🧩 Browser Extensions</summary>

- [Indie Wiki Buddy](styles/indie-wiki-buddy)
- [Shinigami Eyes](styles/shinigami-eyes)
- [Stylus](styles/stylus)

</details>
<details open>
<summary>🔎 Search Engines</summary>

- [Brave Search](styles/brave-search)
- [DuckDuckGo](styles/duckduckgo)
- ❤️‍🩹 [Ecosia](styles/ecosia)
- ❤️‍🩹 [Google](styles/google)
- [Mullvad Leta](styles/mullvad-leta)
- [NixOS Search](styles/nixos-search)
- [SearXNG](styles/searxng)
- ❤️‍🩹 [Startpage](styles/startpage)

</details>
<details open>
<summary>📦 Package Registries</summary>

- [crates.io](styles/crates.io)
- [Hackage](styles/hackage)
- [npm](styles/npm)
- [PyPI](styles/pypi)

</details>
<details open>
<summary>🗺️ Translation Tools</summary>

- [Crowdin](styles/crowdin)
- [DeepL](styles/deepl)
- [ichi.moe](styles/ichi.moe)
- [Jisho](styles/jisho)
- [Lingva](styles/lingva)

</details>
<details open>
<summary>🧠 Wikis</summary>

- ❤️‍🩹 [Arch Wiki](styles/arch-wiki)
- [NixOS Wiki](styles/wiki.nixos.org)
- [Wikipedia](styles/wikipedia)
- [Wikiwand](styles/wikiwand)

</details>
<details open>
<summary>📸 Photo &amp; Video</summary>

- [Google Photos](styles/google-photos)
- [Pinterest](styles/pinterest)

</details>
<details open>
<summary>🎵 Music</summary>

- [Hyperpipe](styles/hyperpipe)
- [Last.fm](styles/lastfm)
- [ListenBrainz](styles/listenbrainz)
- [Spotify Web](styles/spotify-web)

</details>
<details open>
<summary>📖 Productivity</summary>

- [AlternativeTo](styles/alternativeto)
- [cobalt](styles/cobalt)
- [Google Drive](styles/google-drive)
- [Have I Been Pwned](styles/have-i-been-pwned)
- [homepage](styles/homepage)
- [inoreader](styles/inoreader)
- [keybr.com](styles/keybr.com)
- ❤️‍🩹 [Microsoft Word](styles/microsoft-word)
- [Porkbun](styles/porkbun)
- [Proton](styles/proton)
- [Raindrop](styles/raindrop)
- [Rentry.co](styles/rentry.co)
- [tldraw](styles/tldraw)
- [Vikunja](styles/vikunja)
- [Zen Browser Docs](styles/zen-browser-docs)

</details>
<details open>
<summary>💌 Email Clients</summary>

- [Gmail](styles/gmail)
- [Migadu Webmail](styles/migadu-webmail)
- [Tuta](styles/tuta)

</details>
<details open>
<summary>🕹️ Game Development</summary>

- [NameMC](styles/namemc)

</details>
<details open>
<summary>📝 Note Taking</summary>

- [Amplenote](styles/amplenote)

</details>
<details open>
<summary>🎓 Education</summary>

- [Canvas LMS](styles/canvas-lms)
- [Desmos](styles/desmos)
- [Formative](styles/formative)
- [Quizlet](styles/quizlet)

</details>
<details open>
<summary>📰 News &amp; Journalism</summary>

- [Substack](styles/substack)

</details>
<details open>
<summary>✨ Social Networking</summary>

- [Bluesky Social](styles/bsky)
- [Cinny](styles/cinny)
- [Elk](styles/elk)
- [Instagram](styles/instagram)
- ❤️‍🩹 [LinkedIn](styles/linkedin)
- [Mastodon](styles/mastodon)
- [Nitter](styles/nitter)
- [Phanpy](styles/phanpy)
- [pronouns.cc](styles/pronouns.cc)
- [Pronouns.page](styles/pronouns.page)
- [Snapchat Web](styles/snapchat-web)
- [status.cafe](styles/status.cafe)
- [Twitter](styles/twitter)
- [WhatsApp Web](styles/whatsapp-web)

</details>
<details open>
<summary>🗣️ Discussion Forums</summary>

- [DEV Community](styles/dev.to)
- [Hacker News](styles/hacker-news)
- [Lemmy](styles/lemmy)
- ❤️‍🩹 [Libreddit](styles/libreddit)
- [Lobsters](styles/lobste.rs)
- ❤️‍🩹 [Reddit](styles/reddit)
- ❤️‍🩹 [Redlib](styles/libreddit)
- [Stack Overflow](styles/stack-overflow)
- [TabNews](styles/tabnews)

</details>
<details open>
<summary>🌈 Entertainment</summary>

- [7TV](styles/seventv)
- [AniChart](styles/anilist)
- [AniList](styles/anilist)
- [ChatReplay](styles/chatreplay)
- [Holodex](styles/holodex)
- ❤️‍🩹 [Invidious](styles/invidious)
- [Picrew](styles/picrew)
- [Twitch](styles/twitch)
- [YouTube](styles/youtube)

</details>
<details open>
<summary>🎮 Games</summary>

- [Advent Of Code](styles/advent-of-code)
- [Chess.com](styles/chess.com)
- [Lichess](styles/lichess)
- ❤️‍🩹 [Minesweeper Online](styles/minesweeper)
- [Modrinth](styles/modrinth)
- [Planet Minecraft](styles/planet-minecraft)

</details>
<details open>
<summary>📊 Analytics</summary>

- [bStats](styles/bstats)

</details>
<details open>
<summary>🤖 Artificial Intelligence</summary>

- [ChatGPT](styles/chatgpt)
- [Claude](styles/claude)
- [Google Gemini](styles/google-gemini)
- [InvokeAI](styles/invokeai)
- [Ollama](styles/ollama)
- [Perplexity](styles/perplexity)

</details>

<!-- AUTOGEN:USERSTYLES END -->
<p align="center">
Visit <a href="https://userstyles.catppuccin.com">userstyles.catppuccin.com</a> to get started.
</p>

&nbsp;

Expand Down
21 changes: 21 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# build output
dist/
# generated types
.astro/

# dependencies
node_modules/

# logs
npm-debug.log*
yarn-debug.log*
yarn-error.log*
pnpm-debug.log*


# environment variables
.env
.env.production

# macOS-specific files
.DS_Store
30 changes: 0 additions & 30 deletions docs/SUMMARY.md

This file was deleted.

Loading