Docs: enhance features page, add uninstall section, move layout controls, add contributors page, optimize image loading

Matars · Matars · commit 8d368ab040af · 2025-10-26T02:08:57.000+01:00
diff --git a/docs/assets/css/custom-dark-moke.css b/docs/assets/css/custom-dark-moke.css
@@ -15,7 +15,7 @@
   --jtd-accent: #8ab4f8; /* soft blue accent */
   --jtd-primary-text: #d6d7d9; /* light gray text */
   --jtd-muted-text: #9aa0a6; /* muted text */
-  --jtd-border: rgba(255,255,255,0.06);
+  --jtd-border: rgba(255, 255, 255, 0.06);
 }
 
 body {
@@ -35,12 +35,15 @@ body {
 }
 
 /* Links and accents */
-a, .btn, .site-header a {
+a,
+.btn,
+.site-header a {
   color: var(--jtd-accent);
 }
 
 /* Make code blocks slightly warmer */
-.highlight, pre {
+.highlight,
+pre {
   background: #0b0c0d; /* dark */
   color: #e6e6e6;
 }
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -58,15 +58,6 @@ muted = #586069
 
 See the full list in the [colors documentation](colors.md).
 
-## Layout Control
-
-gitfetch automatically adapts to your terminal size, but you can control spacing:
-
-```bash
-gitfetch --spaced     # Enable spaced layout
-gitfetch --not-spaced # Disable spaced layout
-```
-
 ## Custom Dimensions and Coloring Accuracy
 
 The coloring system uses GitHub's standard contribution levels:
diff --git a/docs/contributors.md b/docs/contributors.md
@@ -0,0 +1,33 @@
+---
+layout: default
+title: Contributors & Acknowledgements
+nav_order: 8
+---
+
+# Contributors & Acknowledgements
+
+## Contributors
+
+We'd like to thank all the amazing contributors who have helped make gitfetch better:
+
+- **ilonic23**: Added nix packaging
+- **quunarc**: Small code refactoring
+- **Zeviraty**: Small fixes, color configuration
+- **Vaishnav-Sabari-Girish**: Better installation instructions
+- **Noirbizzarre**: Added installation instructions using uv and pipx
+- **Fwtwoo**: README update
+- **Joeliscoding**: Added homebrew formula and fixed README
+
+## Acknowledgements
+
+gitfetch stands on the shoulders of giants. We're grateful for the inspiration and tools that made this project possible:
+
+### Design Inspiration
+- **Kusa** by Ryu0118 - Beautiful contribution graph design that inspired our visual approach
+- **songfetch** by fwtwoo - The very cool and extremely fun tool that showed us the power of creative terminal displays
+
+### Technical Inspiration
+- **gitfiti** by gelstudios - The `--text` and `--shape` contribution-graph simulation features take inspiration from and adapt ideas from this project. Credit to gelstudios for the concept of painting the contribution calendar (our implementation only simulates the appearance and does not modify git history).
+
+### Community
+A special thanks to the open source community for creating the tools and libraries that power gitfetch, and to all our users for their feedback and support!
diff --git a/docs/features.md b/docs/features.md
@@ -4,47 +4,59 @@ title: Features
 nav_order: 2
 ---
 
+---
+layout: default
+title: Features
+nav_order: 2
+---
+
 # Features
 
-gitfetch provides a beautiful, neofetch-style display of your git hosting platform statistics with extensive customization options.
+gitfetch brings the magic of neofetch to your git hosting platforms, displaying your coding activity in a stunning, colorful terminal interface that's both beautiful and highly customizable.
+
+## 🚀 Core Features
+
+- **Neofetch-style display** with stunning ASCII art that brings your stats to life
+- **Comprehensive statistics** from GitHub, GitLab, Gitea, Forgejo, Codeberg, and Sourcehut
+- **Smart SQLite-based caching** system for lightning-fast subsequent runs
+- **Cross-platform support** (macOS and Linux) - works wherever you code
+- **View active pull requests and issues** - stay on top of your contributions
+- **Display commit streak information** - track your coding momentum
+- **Extensive customization** options that let you make it truly yours
 
-## Core Features
+## 🎨 Visual Customization
 
-- **Neofetch-style display** with ASCII art
-- **Comprehensive statistics** from multiple git hosting platforms
-- **Smart SQLite-based caching** system for faster subsequent runs
-- **Cross-platform support** (macOS and Linux)
-- **First-run initialization** with interactive provider selection
-- **Extensive customization** options for contribution characters, sections, and display elements
+Transform your gitfetch display with powerful visual options:
 
-## Visual Customization
+- **Custom contribution characters** - use any symbol or emoji for your graph blocks
+- **Dynamic section control** - hide/show achievements, languages, issues, PRs, and more
+- **Flexible dimensions** - adjust width and height to fit your terminal perfectly
+- **ASCII art simulation** - create pixel art from text or use predefined shapes like kitty, cat, heart, and star
+- **Advanced color customization** with hex codes and predefined color schemes
 
-- Customize contribution block characters
-- Hide/show specific sections (achievements, languages, issues, PRs, etc.)
-- Control display dimensions and layout
-- Simulate contribution-graph pixel art from text or predefined shapes
+## 🌐 Supported Platforms
 
-## Supported Platforms
+Connect to all major git hosting platforms:
 
-- **GitHub** - Uses GitHub CLI (gh) for authentication
-- **GitLab** - Uses GitLab CLI (glab) for authentication
-- **Gitea/Forgejo/Codeberg** - Uses personal access tokens
-- **Sourcehut** - Uses personal access tokens
+- **GitHub** - Seamless integration with GitHub CLI (gh) authentication
+- **GitLab** - Full support with GitLab CLI (glab) authentication
+- **Gitea/Forgejo/Codeberg** - Personal access token authentication for self-hosted instances
+- **Sourcehut** - OAuth2 personal access token support
 
-## Advanced Options
+## ⚡ Advanced Capabilities
 
-- Repository-specific stats for local git repositories
-- Cache management (bypass, clear)
-- Provider switching
-- Custom graph dimensions
-- Layout control (spaced/not spaced)
+- **Repository-specific stats** - analyze local git repositories for detailed contribution graphs
+- **Intelligent cache management** - bypass or clear cache when needed
+- **Provider switching** - easily switch between different git platforms
+- **Custom graph dimensions** - fine-tune your display for any terminal size
+- **Layout control** - choose between spaced and compact layouts
 
-## Intelligent Layout System
+## 🧠 Intelligent Layout System
 
-gitfetch automatically adapts to your terminal size:
+gitfetch automatically adapts to your terminal environment:
 
-- **Full Layout**: All sections when width ≥ 120 columns
-- **Compact Layout**: Graph and key info side-by-side for medium terminals
-- **Minimal Layout**: Contribution graph only for narrow terminals
+- **Full Layout**: Complete information display when you have 120+ columns
+- **Compact Layout**: Side-by-side graph and stats for medium terminals
+- **Minimal Layout**: Clean contribution graph for narrow screens
 
-The system considers both terminal width and height for optimal display.
+The system intelligently considers both terminal width AND height to deliver the optimal viewing experience, no matter your setup.
diff --git a/docs/index.md b/docs/index.md
@@ -8,7 +8,7 @@ nav_order: 1
 
 A neofetch-style CLI tool for GitHub, GitLab, Gitea, Forgejo, Codeberg, and Sourcehut statistics. Display your profile and stats from various git hosting platforms in a beautiful, colorful terminal interface with extensive customization options and intelligent layout adaptation.
 
-![gitfetch screenshot](https://github.com/user-attachments/assets/bbb18d5d-4787-4998-a352-e8f4e59642c0)
+![gitfetch screenshot](https://github.com/user-attachments/assets/bbb18d5d-4787-4998-a352-e8f4e59642c0){: loading="lazy" width="800" height="520" }
 
 ## Quick Start
 
diff --git a/docs/installation.md b/docs/installation.md
@@ -82,3 +82,47 @@ When you run `gitfetch` for the first time, you'll be prompted to:
 4. **Configure access tokens** (if using Gitea/Forgejo/Codeberg or Sourcehut)
 
 The setup process will provide helpful error messages and installation instructions if anything is missing.
+
+## Uninstall
+
+### Homebrew
+
+```bash
+brew uninstall gitfetch          # Uninstall gitfetch
+brew untap matars/gitfetch       # Remove the tap
+```
+
+### pip
+
+```bash
+pip uninstall gitfetch
+```
+
+### uv
+
+```bash
+uv tool uninstall gitfetch
+```
+
+### pipx
+
+```bash
+pipx uninstall gitfetch
+```
+
+### AUR (Arch Linux)
+
+```bash
+yay -R gitfetch-python
+```
+
+Or with other AUR helpers:
+
+```bash
+paru -R gitfetch-python
+trizen -R gitfetch-python
+```
+
+### NixOS
+
+Remove the gitfetch input from your flake and remove it from `environment.systemPackages`.

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@`
`15`	`15`	`--jtd-accent: #8ab4f8; /* soft blue accent */`
`16`	`16`	`--jtd-primary-text: #d6d7d9; /* light gray text */`
`17`	`17`	`--jtd-muted-text: #9aa0a6; /* muted text */`
`18`		`- --jtd-border: rgba(255,255,255,0.06);`
	`18`	`+ --jtd-border: rgba(255, 255, 255, 0.06);`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`body {`
`@@ -35,12 +35,15 @@ body {`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`/* Links and accents */`
`38`		`-a, .btn, .site-header a {`
	`38`	`+a,`
	`39`	`+.btn,`
	`40`	`+.site-header a {`
`39`	`41`	`color: var(--jtd-accent);`
`40`	`42`	`}`
`41`	`43`
`42`	`44`	`/* Make code blocks slightly warmer */`
`43`		`-.highlight, pre {`
	`45`	`+.highlight,`
	`46`	`+pre {`
`44`	`47`	`background: #0b0c0d; /* dark */`
`45`	`48`	`color: #e6e6e6;`
`46`	`49`	`}`