Skip to content

Commit 5837cb5

Browse files
committed
update docs
1 parent f750425 commit 5837cb5

143 files changed

Lines changed: 552 additions & 40336 deletions

File tree

Some content is hidden

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

docs/customization/appearance.mdx

Lines changed: 4 additions & 114 deletions
Original file line numberDiff line numberDiff line change
@@ -76,107 +76,13 @@ You pick one active theme at a time. There is no separate "light theme" and "dar
7676

7777
## Customizing Themes
7878

79-
Select a theme in the sidebar, then edit it directly in the right panel.
79+
Select a theme and edit directly. For built-in themes, you can always edit fonts, and you can modify colors/layout by duplicating first.
8080

81-
### Fonts Tab
81+
Built-in themes auto-duplicate when you make changes, preserving the original.
8282

83-
Always editable, even on built-in themes. If you change a font on a built-in theme, TablePro auto-duplicates it as a custom theme so the original stays untouched.
83+
## Import, Export & Registry
8484

85-
Four settings:
86-
87-
- **Editor font family** (used in the SQL editor)
88-
- **Editor font size**
89-
- **Data grid font family** (used in result grid cells)
90-
- **Data grid font size**
91-
92-
A live preview updates as you change values.
93-
94-
<Tip>
95-
If you only want to change fonts without touching colors, just adjust the font fields. The auto-duplicate handles the rest.
96-
</Tip>
97-
98-
### Colors Tab
99-
100-
Defines 50+ colors across 5 categories. For built-in themes, the Colors tab shows a "Duplicate to customize" prompt. Duplicate first, then edit freely.
101-
102-
| Category | What It Controls |
103-
|----------|-----------------|
104-
| **Editor** | Background, text, cursor, current line highlight, selection, line numbers, invisibles, and 8 syntax colors (keyword, string, number, comment, null, operator, function, type) |
105-
| **Data Grid** | Background, text, alternate row, null value, boolean true/false, row number, modified/inserted/deleted row highlights, focus border |
106-
| **Interface** | Window/control/card backgrounds, borders, primary/secondary/tertiary text, accent color, selection, hover, status colors (success/warning/error/info), badge colors |
107-
| **Sidebar** | Background, text, selected item, hover, section header |
108-
| **Toolbar** | Secondary text, tertiary text |
109-
110-
Each color is edited via a hex color picker.
111-
112-
### Layout Tab
113-
114-
Defines 30+ layout tokens across 6 sections. Same lock behavior as Colors: built-in themes require duplication before editing.
115-
116-
| Section | Tokens |
117-
|---------|--------|
118-
| **Typography** | Font sizes: tiny (9), caption (10), small (11), medium (12), body (13), title3 (15), title2 (17) |
119-
| **Spacing** | Scale from xxxs (2) to xl (24), plus list row insets |
120-
| **Icon Sizes** | 9 sizes from tinyDot (6) to massive (64) |
121-
| **Corner Radius** | Small (4), medium (6), large (8) |
122-
| **Row Heights** | Compact (24), table (32), comfortable (44) |
123-
| **Animations** | Durations: fast (0.1s), normal (0.15s), smooth (0.2s), slow (0.3s) |
124-
125-
Values in parentheses are defaults.
126-
127-
## Import and Export
128-
129-
### Exporting a Theme
130-
131-
1. Select the theme in the sidebar
132-
2. Click the **gear** menu at the bottom of the sidebar
133-
3. Choose **Export...**
134-
4. Pick a save location
135-
136-
The exported `.json` file contains all colors, fonts, and layout tokens.
137-
138-
### Importing a Theme
139-
140-
1. Click the **+** menu at the bottom of the sidebar
141-
2. Choose **Import...**
142-
3. Select a `.json` theme file
143-
144-
The imported theme appears in the "Custom" section.
145-
146-
<Note>
147-
Custom themes are stored as JSON files in `~/Library/Application Support/TablePro/Themes/`.
148-
</Note>
149-
150-
## Registry Themes
151-
152-
Install community-created themes from the plugin registry without leaving the app.
153-
154-
### Installing a Theme
155-
156-
1. Go to **Settings > Plugins > Browse**
157-
2. Filter by **Themes** category
158-
3. Click **Install Theme** on the theme you want
159-
4. The theme appears in the "Registry" section of **Settings > Appearance**
160-
161-
Registry themes are read-only. To customize one, duplicate it first: the copy appears in the "Custom" section and is fully editable.
162-
163-
### Uninstalling a Theme
164-
165-
1. Select the registry theme in **Settings > Appearance**
166-
2. Click the **gear** menu
167-
3. Choose **Uninstall**
168-
169-
If the uninstalled theme was active, TablePro falls back to Default Light.
170-
171-
<Note>
172-
Registry themes are stored in `~/Library/Application Support/TablePro/Themes/Registry/`. They use a `registry.*` ID prefix to avoid conflicts with built-in and custom themes.
173-
</Note>
174-
175-
### Theme File Format
176-
177-
Theme files are JSON with these top-level keys: `id`, `name`, `version`, `appearance`, `author`, `editor`, `dataGrid`, `ui`, `sidebar`, `toolbar`, `fonts`, `spacing`, `typography`, `iconSizes`, `cornerRadius`, `rowHeights`, `animations`.
178-
179-
All fields are optional on import. Missing fields fall back to Default Light values.
85+
Export custom themes as JSON. Import themes from files or install from the plugin registry (**Settings > Plugins > Browse**, filter by Themes). Registry themes are read-onlyduplicate to customize.
18086

18187
## Connection Colors
18288

@@ -272,19 +178,3 @@ These appear on:
272178
/>
273179
</Frame>
274180

275-
## Related Settings
276-
277-
<CardGroup cols={2}>
278-
<Card title="Editor Settings" icon="code" href="/customization/editor-settings">
279-
Font and editor appearance
280-
</Card>
281-
<Card title="Settings Overview" icon="gear" href="/customization/settings">
282-
All settings categories
283-
</Card>
284-
<Card title="Data Grid" icon="table" href="/features/data-grid">
285-
Configure data display
286-
</Card>
287-
<Card title="Connections" icon="plug" href="/databases/overview">
288-
Connection color settings
289-
</Card>
290-
</CardGroup>

docs/customization/editor-settings.mdx

Lines changed: 3 additions & 156 deletions
Original file line numberDiff line numberDiff line change
@@ -39,16 +39,6 @@ Available monospace fonts:
3939
**System Mono** automatically uses the best available system monospace font.
4040
</Tip>
4141

42-
### Font Availability
43-
44-
| Font | Availability |
45-
|------|--------------|
46-
| System Mono | Always available |
47-
| SF Mono | macOS 10.12+ |
48-
| Menlo | macOS 10.6+ |
49-
| Monaco | macOS Classic |
50-
| Courier New | Standard system font |
51-
5242
If a selected font isn't available, TablePro falls back to System Mono.
5343

5444
{/* Screenshot: Font family selector */}
@@ -128,10 +118,8 @@ Line numbers are useful for:
128118

129119
| Option | Description |
130120
|--------|-------------|
131-
| **On** | Subtly highlight the line with cursor (default) |
132-
| **Off** | No highlight on current line |
133-
134-
Helps track your cursor position in long queries.
121+
| **On** | Highlight the line with cursor (default) |
122+
| **Off** | No highlight |
135123

136124
{/* Screenshot: Current line highlight */}
137125
<Frame caption="Current line highlighting in the editor">
@@ -154,18 +142,6 @@ Helps track your cursor position in long queries.
154142
| **Off** | Long lines scroll horizontally (default) |
155143
| **On** | Long lines wrap to next line |
156144

157-
**Enable word wrap when**:
158-
159-
- Working on narrow screens
160-
- Queries have long lines
161-
- You want to avoid horizontal scrolling
162-
163-
**Disable word wrap when**:
164-
165-
- You prefer consistent line lengths
166-
- Working with pre-formatted queries
167-
- You need to see query structure clearly
168-
169145
{/* Screenshot: Word wrap */}
170146
<Frame caption="Word wrap: wrapped vs horizontal scrolling">
171147
<img
@@ -259,94 +235,7 @@ See [Autocomplete](/features/autocomplete) for details.
259235

260236
All changes apply immediately. No restart required.
261237

262-
## Recommended Configurations
263-
264-
### Default (Balanced)
265-
266-
```
267-
Font Family: System Mono
268-
Font Size: 13 pt
269-
Line Numbers: On
270-
Current Line: On
271-
Tab Width: 4
272-
Auto Indent: On
273-
Word Wrap: Off
274-
```
275-
276-
### Compact (More Code Visible)
277-
278-
```
279-
Font Family: SF Mono
280-
Font Size: 11 pt
281-
Line Numbers: On
282-
Current Line: On
283-
Tab Width: 2
284-
Auto Indent: On
285-
Word Wrap: Off
286-
```
287-
288-
### Comfortable (Easy Reading)
289-
290-
```
291-
Font Family: Menlo
292-
Font Size: 15 pt
293-
Line Numbers: On
294-
Current Line: On
295-
Tab Width: 4
296-
Auto Indent: On
297-
Word Wrap: On
298-
```
299-
300-
### Minimal (Clean Interface)
301-
302-
```
303-
Font Family: Monaco
304-
Font Size: 13 pt
305-
Line Numbers: Off
306-
Current Line: Off
307-
Tab Width: 4
308-
Auto Indent: On
309-
Word Wrap: Off
310-
```
311-
312-
### Accessibility
313-
314-
```
315-
Font Family: System Mono
316-
Font Size: 18 pt
317-
Line Numbers: On
318-
Current Line: On
319-
Tab Width: 4
320-
Auto Indent: On
321-
Word Wrap: On
322-
```
323-
324-
## Syntax Highlighting
325-
326-
SQL syntax is highlighted automatically:
327-
328-
| Element | Color (Dark) | Color (Light) |
329-
|---------|--------------|---------------|
330-
| Keywords | Pink | Pink |
331-
| Strings | Green | Green |
332-
| Numbers | Blue | Blue |
333-
| Comments | Gray | Gray |
334-
| Functions | Default | Default |
335-
| Identifiers | White | Black |
336-
337-
Colors adapt to the current theme.
338-
339-
### Highlighted Keywords
340-
341-
SQL keywords that are highlighted:
342-
343-
- `SELECT`, `INSERT`, `UPDATE`, `DELETE`, `CREATE`, `ALTER`, `DROP`
344-
- `FROM`, `WHERE`, `JOIN`, `ON`, `GROUP BY`, `ORDER BY`, `HAVING`
345-
- `AND`, `OR`, `NOT`, `IN`, `LIKE`, `BETWEEN`, `IS NULL`
346-
- `INNER`, `LEFT`, `RIGHT`, `OUTER`, `CROSS`, `UNION`
347-
- And many more SQL standard keywords
348-
349-
## Keyboard Shortcuts in Editor
238+
## Keyboard Shortcuts
350239

351240
| Action | Shortcut |
352241
|--------|----------|
@@ -357,45 +246,3 @@ SQL keywords that are highlighted:
357246
| Replace | `Cmd+Option+F` |
358247
| Select All | `Cmd+A` |
359248
| Go to Line | `Cmd+G` |
360-
361-
See [Keyboard Shortcuts](/features/keyboard-shortcuts) for the complete list.
362-
363-
## Troubleshooting
364-
365-
### Font Not Appearing Correctly
366-
367-
1. Verify the font is installed on your system
368-
2. Try a different font
369-
3. Restart TablePro
370-
371-
### Settings Not Saving
372-
373-
1. Check disk permissions
374-
2. Verify preferences file is writable:
375-
```bash
376-
ls -la ~/Library/Preferences/com.TablePro.plist
377-
```
378-
3. Try resetting preferences
379-
380-
### Editor Feels Slow
381-
382-
1. Reduce font size (larger fonts render slower)
383-
2. Disable word wrap for long queries
384-
3. Check for very large queries in the editor
385-
386-
## Related Pages
387-
388-
<CardGroup cols={2}>
389-
<Card title="SQL Editor" icon="code" href="/features/sql-editor">
390-
Editor features and usage
391-
</Card>
392-
<Card title="Autocomplete" icon="wand-magic-sparkles" href="/features/autocomplete">
393-
Autocomplete functionality
394-
</Card>
395-
<Card title="Appearance" icon="palette" href="/customization/appearance">
396-
Theme and colors
397-
</Card>
398-
<Card title="Keyboard Shortcuts" icon="keyboard" href="/features/keyboard-shortcuts">
399-
All keyboard shortcuts
400-
</Card>
401-
</CardGroup>

0 commit comments

Comments
 (0)