gh-here 3.0.0 → 3.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +34 -27
- package/package.json +6 -3
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# gh-here
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
A fast, local GitHub-style file browser for exploring codebases. Browse directories with a file tree, view files with syntax highlighting, and explore git diffs - all in your browser.
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
@@ -18,39 +18,42 @@ npm install -g gh-here
|
|
|
18
18
|
|
|
19
19
|
```bash
|
|
20
20
|
gh-here # Start server on available port
|
|
21
|
-
gh-here --open # Start and open browser
|
|
21
|
+
gh-here --open # Start and open browser (default)
|
|
22
22
|
gh-here --port=8080 # Use specific port
|
|
23
23
|
gh-here --open --browser=safari # Open in Safari
|
|
24
24
|
```
|
|
25
25
|
|
|
26
26
|
## Features
|
|
27
27
|
|
|
28
|
-
|
|
29
|
-
-
|
|
30
|
-
-
|
|
31
|
-
-
|
|
32
|
-
-
|
|
33
|
-
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
-
|
|
37
|
-
-
|
|
38
|
-
-
|
|
39
|
-
-
|
|
28
|
+
### Core
|
|
29
|
+
- **File Tree Sidebar** - Navigate your repository structure with an interactive file tree
|
|
30
|
+
- **Context-Aware Search** - Global repository search or filter the file tree
|
|
31
|
+
- **Client-Side Navigation** - Fast page transitions without full reloads
|
|
32
|
+
- **Syntax Highlighting** - Support for 30+ languages via highlight.js
|
|
33
|
+
- **Git Integration** - Status indicators and diff viewer with line numbers
|
|
34
|
+
|
|
35
|
+
### UI/UX
|
|
36
|
+
- **Gitignore Toggle** - Show/hide gitignored files (persists in localStorage)
|
|
37
|
+
- **Dark/Light Themes** - Toggle between themes
|
|
38
|
+
- **README Preview** - Automatic markdown rendering
|
|
39
|
+
- **Language Statistics** - See breakdown of languages in your repo
|
|
40
|
+
- **File Operations** - Copy file paths, download files, view raw content
|
|
40
41
|
|
|
41
42
|
## Keyboard Shortcuts
|
|
42
43
|
|
|
43
44
|
| Key | Action |
|
|
44
45
|
|-----|--------|
|
|
45
|
-
| `
|
|
46
|
-
| `
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
46
|
+
| `Cmd/Ctrl + K` | Focus search |
|
|
47
|
+
| `Escape` | Close search/modals |
|
|
48
|
+
|
|
49
|
+
## How It Works
|
|
50
|
+
|
|
51
|
+
gh-here runs a local Express server that serves a read-only view of your codebase. It:
|
|
52
|
+
|
|
53
|
+
1. Respects your `.gitignore` (optional toggle to show ignored files)
|
|
54
|
+
2. Shows git status and diffs for modified files
|
|
55
|
+
3. Provides a familiar GitHub-like interface
|
|
56
|
+
4. Works entirely offline - no data leaves your machine
|
|
54
57
|
|
|
55
58
|
## Development
|
|
56
59
|
|
|
@@ -61,7 +64,11 @@ npm start
|
|
|
61
64
|
|
|
62
65
|
## Dependencies
|
|
63
66
|
|
|
64
|
-
- express
|
|
65
|
-
- highlight.js
|
|
66
|
-
- marked
|
|
67
|
-
- @primer/octicons
|
|
67
|
+
- express - Web server
|
|
68
|
+
- highlight.js - Syntax highlighting
|
|
69
|
+
- marked - Markdown rendering
|
|
70
|
+
- @primer/octicons - GitHub icons
|
|
71
|
+
|
|
72
|
+
## License
|
|
73
|
+
|
|
74
|
+
MIT
|
package/package.json
CHANGED
|
@@ -1,11 +1,14 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "gh-here",
|
|
3
|
-
"version": "3.0.
|
|
3
|
+
"version": "3.0.1",
|
|
4
4
|
"description": "A local GitHub-like file browser for viewing code",
|
|
5
|
-
"repository":
|
|
5
|
+
"repository": {
|
|
6
|
+
"type": "git",
|
|
7
|
+
"url": "git+https://github.com/corywilkerson/gh-here.git"
|
|
8
|
+
},
|
|
6
9
|
"main": "index.js",
|
|
7
10
|
"bin": {
|
|
8
|
-
"gh-here": "
|
|
11
|
+
"gh-here": "bin/gh-here.js"
|
|
9
12
|
},
|
|
10
13
|
"scripts": {
|
|
11
14
|
"start": "node bin/gh-here.js",
|