Skip to content

Commit 84c0edf

Browse files
trueberrylessuncentersgoudhamWalkQuackBack
authored
docs: add starlight (#1859)
Co-authored-by: uncenter <[email protected]> Co-authored-by: Hammy <[email protected]> Co-authored-by: WalkQuackBack <[email protected]>
1 parent d5e22ed commit 84c0edf

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

46 files changed

+5967
-522
lines changed

.github/workflows/docs.yml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: Deploy Docs to GH Pages
2+
3+
on:
4+
push:
5+
branches: [main]
6+
paths:
7+
- 'docs/**'
8+
workflow_dispatch:
9+
10+
permissions:
11+
contents: read
12+
pages: write
13+
id-token: write
14+
15+
jobs:
16+
build:
17+
runs-on: ubuntu-latest
18+
steps:
19+
- uses: actions/checkout@v5
20+
- name: Build & Upload Site
21+
uses: withastro/action@v4
22+
with:
23+
path: ./docs
24+
package-manager: [email protected]
25+
26+
deploy:
27+
needs: build
28+
runs-on: ubuntu-latest
29+
environment:
30+
name: github-pages
31+
url: ${{ steps.deployment.outputs.page_url }}
32+
steps:
33+
- name: Deploy to GitHub Pages
34+
id: deployment
35+
uses: actions/deploy-pages@v4

.github/workflows/website.yml

Lines changed: 0 additions & 20 deletions
This file was deleted.

README.md

Lines changed: 4 additions & 265 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,6 @@
55
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/misc/transparent.png" height="30" width="0px"/>
66
</h3>
77

8-
<p align="center">
9-
<img src="https://raw.githubusercontent.com/catppuccin/catppuccin/main/assets/palette/macchiato.png" width="400" />
10-
</p>
11-
128
<p align="center">
139
<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>
1410
<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>
@@ -21,269 +17,12 @@ A curated collection of soothing pastel themes for your favorite websites and we
2117
</p>
2218

2319
<p align="center">
24-
<img src="docs/images/preview.webp"/>
20+
<img src="docs/src/assets/preview.webp"/>
2521
</p>
2622

27-
## Getting started
28-
29-
To get started using the catppuccin/userstyles collection, see [Usage](docs/USAGE.md).
30-
31-
To get started contributing to catppuccin/userstyles, see [Contributing](docs/CONTRIBUTING.md) and [Userstyle Creation](docs/userstyle-creation.md).
32-
33-
## 🖌 Userstyles
34-
35-
> [!IMPORTANT]
36-
> Userstyles labeled with the "❤️‍🩹" emoji lack maintainers, and may not work as intended. Contributions are still welcome and encouraged!
37-
38-
<!-- AUTOGEN:USERSTYLES START -->
39-
<!-- The following section is auto-generated, do not edit. -->
40-
<details open>
41-
<summary>💭 Development Tools</summary>
42-
43-
- [boringproxy](styles/boringproxy)
44-
- [Codeberg](styles/codeberg)
45-
- [DevDocs](styles/devdocs)
46-
- [docs.deno.com](styles/docs.deno.com)
47-
- [docs.rs](styles/docs.rs)
48-
- [freedesktop.org](styles/freedesktop)
49-
- [GitHub](styles/github)
50-
- [gleam.run](styles/gleam.run)
51-
- [go.dev](styles/go.dev)
52-
- [Grabify](styles/grabify)
53-
- ❤️‍🩹 [Graphite](styles/graphite)
54-
- [Home Manager Options Search](styles/home-manager-options-search)
55-
- [Hoogle](styles/hoogle)
56-
- [Hoppscotch](styles/hoppscotch)
57-
- [Keyoxide](styles/keyoxide)
58-
- [Learn X in Y Minutes](styles/learn-x-in-y-minutes)
59-
- [MDN](styles/mdn)
60-
- [Next.js](styles/vercel)
61-
- [NixOS Manual](styles/nixos-manual)
62-
- [Nixpkgs Manual](styles/nixos-manual)
63-
- [paste.rs](styles/paste.rs)
64-
- [PythonAnywhere](styles/pythonanywhere)
65-
- [React.dev](styles/react.dev)
66-
- [Trinket](styles/trinket)
67-
- [Vercel](styles/vercel)
68-
- [web.dev](styles/web.dev)
69-
70-
</details>
71-
<details open>
72-
<summary>📜 Documentation Generators</summary>
73-
74-
- [mdBook](styles/mdbook)
75-
76-
</details>
77-
<details open>
78-
<summary>🌱 Terminals</summary>
79-
80-
- [Ghostty.org](styles/ghostty.org)
81-
82-
</details>
83-
<details open>
84-
<summary>🗂️ File Managers</summary>
85-
86-
- [openmediavault](styles/openmediavault)
87-
- [Syncthing](styles/syncthing)
88-
89-
</details>
90-
<details open>
91-
<summary>🧩 Browser Extensions</summary>
92-
93-
- [Indie Wiki Buddy](styles/indie-wiki-buddy)
94-
- [Shinigami Eyes](styles/shinigami-eyes)
95-
- [Stylus](styles/stylus)
96-
97-
</details>
98-
<details open>
99-
<summary>🔎 Search Engines</summary>
100-
101-
- [Brave Search](styles/brave-search)
102-
- [DuckDuckGo](styles/duckduckgo)
103-
- ❤️‍🩹 [Ecosia](styles/ecosia)
104-
- ❤️‍🩹 [Google](styles/google)
105-
- [Mullvad Leta](styles/mullvad-leta)
106-
- [NixOS Search](styles/nixos-search)
107-
- [SearXNG](styles/searxng)
108-
- ❤️‍🩹 [Startpage](styles/startpage)
109-
110-
</details>
111-
<details open>
112-
<summary>📦 Package Registries</summary>
113-
114-
- [crates.io](styles/crates.io)
115-
- [Hackage](styles/hackage)
116-
- [npm](styles/npm)
117-
- [PyPI](styles/pypi)
118-
119-
</details>
120-
<details open>
121-
<summary>🗺️ Translation Tools</summary>
122-
123-
- [Crowdin](styles/crowdin)
124-
- [DeepL](styles/deepl)
125-
- [ichi.moe](styles/ichi.moe)
126-
- [Jisho](styles/jisho)
127-
- [Lingva](styles/lingva)
128-
129-
</details>
130-
<details open>
131-
<summary>🧠 Wikis</summary>
132-
133-
- ❤️‍🩹 [Arch Wiki](styles/arch-wiki)
134-
- [NixOS Wiki](styles/wiki.nixos.org)
135-
- [Wikipedia](styles/wikipedia)
136-
- [Wikiwand](styles/wikiwand)
137-
138-
</details>
139-
<details open>
140-
<summary>📸 Photo &amp; Video</summary>
141-
142-
- [Google Photos](styles/google-photos)
143-
- [Pinterest](styles/pinterest)
144-
145-
</details>
146-
<details open>
147-
<summary>🎵 Music</summary>
148-
149-
- [Hyperpipe](styles/hyperpipe)
150-
- [Last.fm](styles/lastfm)
151-
- [ListenBrainz](styles/listenbrainz)
152-
- [Spotify Web](styles/spotify-web)
153-
154-
</details>
155-
<details open>
156-
<summary>📖 Productivity</summary>
157-
158-
- [AlternativeTo](styles/alternativeto)
159-
- [cobalt](styles/cobalt)
160-
- [Google Drive](styles/google-drive)
161-
- [Have I Been Pwned](styles/have-i-been-pwned)
162-
- [homepage](styles/homepage)
163-
- [inoreader](styles/inoreader)
164-
- [keybr.com](styles/keybr.com)
165-
- ❤️‍🩹 [Microsoft Word](styles/microsoft-word)
166-
- [Porkbun](styles/porkbun)
167-
- [Proton](styles/proton)
168-
- [Raindrop](styles/raindrop)
169-
- [Rentry.co](styles/rentry.co)
170-
- [tldraw](styles/tldraw)
171-
- [Vikunja](styles/vikunja)
172-
- [Zen Browser Docs](styles/zen-browser-docs)
173-
174-
</details>
175-
<details open>
176-
<summary>💌 Email Clients</summary>
177-
178-
- [Gmail](styles/gmail)
179-
- [Migadu Webmail](styles/migadu-webmail)
180-
- [Tuta](styles/tuta)
181-
182-
</details>
183-
<details open>
184-
<summary>🕹️ Game Development</summary>
185-
186-
- [NameMC](styles/namemc)
187-
188-
</details>
189-
<details open>
190-
<summary>📝 Note Taking</summary>
191-
192-
- [Amplenote](styles/amplenote)
193-
194-
</details>
195-
<details open>
196-
<summary>🎓 Education</summary>
197-
198-
- [Canvas LMS](styles/canvas-lms)
199-
- [Desmos](styles/desmos)
200-
- [Formative](styles/formative)
201-
- [Quizlet](styles/quizlet)
202-
203-
</details>
204-
<details open>
205-
<summary>📰 News &amp; Journalism</summary>
206-
207-
- [Substack](styles/substack)
208-
209-
</details>
210-
<details open>
211-
<summary>✨ Social Networking</summary>
212-
213-
- [Bluesky Social](styles/bsky)
214-
- [Cinny](styles/cinny)
215-
- [Elk](styles/elk)
216-
- [Instagram](styles/instagram)
217-
- ❤️‍🩹 [LinkedIn](styles/linkedin)
218-
- [Mastodon](styles/mastodon)
219-
- [Nitter](styles/nitter)
220-
- [Phanpy](styles/phanpy)
221-
- [pronouns.cc](styles/pronouns.cc)
222-
- [Pronouns.page](styles/pronouns.page)
223-
- [Snapchat Web](styles/snapchat-web)
224-
- [status.cafe](styles/status.cafe)
225-
- [Twitter](styles/twitter)
226-
- [WhatsApp Web](styles/whatsapp-web)
227-
228-
</details>
229-
<details open>
230-
<summary>🗣️ Discussion Forums</summary>
231-
232-
- [DEV Community](styles/dev.to)
233-
- [Hacker News](styles/hacker-news)
234-
- [Lemmy](styles/lemmy)
235-
- ❤️‍🩹 [Libreddit](styles/libreddit)
236-
- [Lobsters](styles/lobste.rs)
237-
- ❤️‍🩹 [Reddit](styles/reddit)
238-
- ❤️‍🩹 [Redlib](styles/libreddit)
239-
- [Stack Overflow](styles/stack-overflow)
240-
- [TabNews](styles/tabnews)
241-
242-
</details>
243-
<details open>
244-
<summary>🌈 Entertainment</summary>
245-
246-
- [7TV](styles/seventv)
247-
- [AniChart](styles/anilist)
248-
- [AniList](styles/anilist)
249-
- [ChatReplay](styles/chatreplay)
250-
- [Holodex](styles/holodex)
251-
- ❤️‍🩹 [Invidious](styles/invidious)
252-
- [Picrew](styles/picrew)
253-
- [Twitch](styles/twitch)
254-
- [YouTube](styles/youtube)
255-
256-
</details>
257-
<details open>
258-
<summary>🎮 Games</summary>
259-
260-
- [Advent Of Code](styles/advent-of-code)
261-
- [Chess.com](styles/chess.com)
262-
- [Lichess](styles/lichess)
263-
- ❤️‍🩹 [Minesweeper Online](styles/minesweeper)
264-
- [Modrinth](styles/modrinth)
265-
- [Planet Minecraft](styles/planet-minecraft)
266-
267-
</details>
268-
<details open>
269-
<summary>📊 Analytics</summary>
270-
271-
- [bStats](styles/bstats)
272-
273-
</details>
274-
<details open>
275-
<summary>🤖 Artificial Intelligence</summary>
276-
277-
- [ChatGPT](styles/chatgpt)
278-
- [Claude](styles/claude)
279-
- [Google Gemini](styles/google-gemini)
280-
- [InvokeAI](styles/invokeai)
281-
- [Ollama](styles/ollama)
282-
- [Perplexity](styles/perplexity)
283-
284-
</details>
285-
286-
<!-- AUTOGEN:USERSTYLES END -->
23+
<p align="center">
24+
Visit <a href="https://userstyles.catppuccin.com">userstyles.catppuccin.com</a> to get started.
25+
</p>
28726

28827
&nbsp;
28928

docs/.gitignore

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# build output
2+
dist/
3+
# generated types
4+
.astro/
5+
6+
# dependencies
7+
node_modules/
8+
9+
# logs
10+
npm-debug.log*
11+
yarn-debug.log*
12+
yarn-error.log*
13+
pnpm-debug.log*
14+
15+
16+
# environment variables
17+
.env
18+
.env.production
19+
20+
# macOS-specific files
21+
.DS_Store

docs/SUMMARY.md

Lines changed: 0 additions & 30 deletions
This file was deleted.

0 commit comments

Comments
 (0)