Skip to content

Commit fd292d2

Browse files
committed
Docs: combine features and usage into single page, reorder cache options lower in usage
1 parent 8d368ab commit fd292d2

File tree

6 files changed

+53
-83
lines changed

6 files changed

+53
-83
lines changed

docs/configuration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: default
33
title: Configuration
4-
nav_order: 5
4+
nav_order: 4
55
---
66

77
# Configuration

docs/contributors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: default
33
title: Contributors & Acknowledgements
4-
nav_order: 8
4+
nav_order: 7
55
---
66

77
# Contributors & Acknowledgements

docs/development.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: default
33
title: Development
4-
nav_order: 7
4+
nav_order: 6
55
---
66

77
# Development

docs/features.md

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

docs/providers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
layout: default
33
title: Supported Providers
4-
nav_order: 6
4+
nav_order: 5
55
---
66

77
# Supported Providers

docs/usage.md

Lines changed: 49 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,42 @@
11
---
22
layout: default
3-
title: Usage
4-
nav_order: 4
3+
title: Features & Usage
4+
nav_order: 2
55
---
66

7-
# Usage
7+
# Features & Usage
8+
9+
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.
10+
11+
## 🚀 Core Features
12+
13+
- **Neofetch-style display** with stunning ASCII art that brings your stats to life
14+
- **Comprehensive statistics** from GitHub, GitLab, Gitea, Forgejo, Codeberg, and Sourcehut
15+
- **Smart SQLite-based caching** system for lightning-fast subsequent runs
16+
- **Cross-platform support** (macOS and Linux) - works wherever you code
17+
- **View active pull requests and issues** - stay on top of your contributions
18+
- **Display commit streak information** - track your coding momentum
19+
- **Extensive customization** options that let you make it truly yours
20+
21+
## 🎨 Visual Customization
22+
23+
Transform your gitfetch display with powerful visual options:
24+
25+
- **Custom contribution characters** - use any symbol or emoji for your graph blocks
26+
- **Dynamic section control** - hide/show achievements, languages, issues, PRs, and more
27+
- **Flexible dimensions** - adjust width and height to fit your terminal perfectly
28+
- **ASCII art simulation** - create pixel art from text or use predefined shapes like kitty, cat, heart, and star
29+
- **Advanced color customization** with hex codes and predefined color schemes
30+
31+
## 🧠 Intelligent Layout System
32+
33+
gitfetch automatically adapts to your terminal environment:
34+
35+
- **Full Layout**: Complete information display when you have 120+ columns
36+
- **Compact Layout**: Side-by-side graph and stats for medium terminals
37+
- **Minimal Layout**: Clean contribution graph for narrow screens
38+
39+
The system intelligently considers both terminal width AND height to deliver the optimal viewing experience, no matter your setup.
840

941
## Basic Usage
1042

@@ -43,20 +75,6 @@ Displays git commit timeline, built from local git history
4375
- No language statistics for the repository
4476
- Limited to local git history analysis
4577

46-
## Cache Options
47-
48-
Bypass cache and fetch fresh data:
49-
50-
```bash
51-
gitfetch username --no-cache
52-
```
53-
54-
Clear cache:
55-
56-
```bash
57-
gitfetch --clear-cache
58-
```
59-
6078
## Configuration
6179

6280
Change the configured git provider:
@@ -116,6 +134,20 @@ gitfetch --no-grid # Hide contribution grid
116134
gitfetch --no-date --no-achievements --custom-box "" --width 60
117135
```
118136

137+
## Cache Options
138+
139+
Bypass cache and fetch fresh data:
140+
141+
```bash
142+
gitfetch username --no-cache
143+
```
144+
145+
Clear cache:
146+
147+
```bash
148+
gitfetch --clear-cache
149+
```
150+
119151
## Layout Control
120152

121153
gitfetch automatically adapts to your terminal size, but you can control spacing:

0 commit comments

Comments
 (0)