mirror of
https://github.com/punkyard/obsidian-lindar.git
synced 2026-07-22 07:45:03 +00:00
docs: options.md master settings reference + README screenshots
This commit is contained in:
parent
0f51dbb430
commit
dba8b91e86
6 changed files with 102 additions and 10 deletions
19
README.md
19
README.md
|
|
@ -1,5 +1,4 @@
|
|||
# **Lindar** is under *development*
|
||||
🚧 Early development — breaking changes may occur
|
||||
# 🚧 **Lindar** is under *development*
|
||||
|
||||
> Yet another yearly linear calendar plugin for Obsidian, designed for long-horizon planning, but:
|
||||
> • yearly
|
||||
|
|
@ -20,7 +19,8 @@ We'd like to thank him for his approach and his inspiration that guided the visu
|
|||
## Documentation
|
||||
|
||||
| Topic | |
|
||||
|---|---|
|
||||
|---|---|---|
|
||||
| All options reference | [`docs/options.md`](docs/options.md) |
|
||||
| Features & event format | [`docs/features.md`](docs/features.md) |
|
||||
| Development guide | [`docs/development.md`](docs/development.md) |
|
||||
| Roadmap | [`docs/roadmap.md`](docs/roadmap.md) |
|
||||
|
|
@ -28,13 +28,10 @@ We'd like to thank him for his approach and his inspiration that guided the visu
|
|||
| Day highlights | [`docs/highlights.md`](docs/highlights.md) |
|
||||
| Categories | [`docs/categories.md`](docs/categories.md) — type labels with default colors, per-event override |
|
||||
| Changelog | [`CHANGELOG.md`](CHANGELOG.md) |
|
||||
|
||||
---
|
||||
## Day highlights
|
||||
|
||||
Lindar highlights weekends and Wednesdays to help you navigate the calendar. Both highlights are enabled by default and can be toggled in **Settings → Community plugins → Lindar**.
|
||||
|
||||
See [`docs/highlights.md`](docs/highlights.md) for details.
|
||||
## Options
|
||||
![[options.png]]
|
||||
## Manage categories
|
||||
![[options-categories.png]]
|
||||
|
||||
---
|
||||
## Quick start
|
||||
|
|
@ -49,6 +46,8 @@ See [`docs/highlights.md`](docs/highlights.md) for details.
|
|||
|
||||

|
||||
|
||||
![[event-note.png]]
|
||||
|
||||
---
|
||||
### ⭐️ **Roadmap** unlocks with GitHub stars:
|
||||
|
||||
|
|
|
|||
Binary file not shown.
|
Before Width: | Height: | Size: 851 KiB After Width: | Height: | Size: 1.7 MiB |
BIN
assets/event-note.png
Normal file
BIN
assets/event-note.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 345 KiB |
BIN
assets/options-categories.png
Normal file
BIN
assets/options-categories.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 207 KiB |
BIN
assets/options.png
Normal file
BIN
assets/options.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 255 KiB |
93
docs/options.md
Normal file
93
docs/options.md
Normal file
|
|
@ -0,0 +1,93 @@
|
|||
# Options
|
||||
|
||||
All settings are in **Settings → Community plugins → Lindar**.
|
||||
|
||||
## Event notes folder
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
| Setting | Event notes folder |
|
||||
| Default | `Lindar` |
|
||||
| Description | Folder used to store calendar event notes. Relative to vault root. Created automatically if it doesn't exist. |
|
||||
|
||||
## Default event color
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
| Setting | Default event color |
|
||||
| Default | `#4f46e5` |
|
||||
| Description | Used as the default color when creating events. A **reset** button restores the default. |
|
||||
|
||||
## Motto
|
||||
|
||||
| | |
|
||||
|---|---|
|
||||
| Setting | Motto |
|
||||
| Default | (empty) |
|
||||
| Description | Message shown in the year view header. |
|
||||
|
||||
## Day highlights
|
||||
|
||||
| Setting | Default | Description |
|
||||
|---|---|---|
|
||||
| Highlight Wednesdays | On | Applies a muted highlight to Wednesday cells. |
|
||||
| Highlight weekends | On | Applies weekend styling to Saturday and Sunday cells. |
|
||||
|
||||
## Event lanes
|
||||
|
||||
| Setting | Default | Description |
|
||||
|---|---|---|
|
||||
| Expand months to fit events | Off | When on, each month expands vertically to show all event lanes. When off, the lane count below applies. |
|
||||
| Visible event lanes per month | `0` | Number of event lanes displayed (may require scroll). `0` distributes rows evenly. Only active when **Expand months** is off. Changes are debounced (500ms). |
|
||||
|
||||
## Categories
|
||||
|
||||
Categories label events by type and auto-assign a default color. Each category has a name, a color, and an enabled toggle.
|
||||
|
||||
### Seed categories
|
||||
|
||||
| Category | Default color |
|
||||
|---|---|
|
||||
| appointment | `#4f46e5` |
|
||||
| call | `#0891b2` |
|
||||
| meal | `#65a30d` |
|
||||
| meeting | `#ca8a04` |
|
||||
| travel | `#ea580c` |
|
||||
| deadline | `#dc2626` |
|
||||
| task | `#7c3aed` |
|
||||
| reminder | `#0d9488` |
|
||||
| other | `#78716c` |
|
||||
|
||||
Add, rename, recolor, or remove any — they are a starting point.
|
||||
|
||||
### Managing categories
|
||||
|
||||
Each category row has two groups:
|
||||
|
||||
**Left group:** ↑ (move up) · ↓ (move down) · name input · color swatch
|
||||
**Right group:** toggle (enable/disable) · trash (delete)
|
||||
|
||||
- **Add:** click **+ Add category** at the bottom. A new row appears with empty name and default color.
|
||||
- **Reorder:** ↑ and ↓ arrows. First row cannot move up; last cannot move down.
|
||||
- **Rename:** type directly in the name field.
|
||||
- **Recolor:** click the color swatch.
|
||||
- **Disable:** toggle off. Disabled categories are hidden from the event modal's type dropdown. Rows dim to 50% opacity. Existing events keep their type text.
|
||||
- **Delete:** trash icon. Irreversible.
|
||||
|
||||
All changes save immediately.
|
||||
|
||||
### Per-event color override
|
||||
|
||||
1. In the event modal, type or select a category from the **Type** field.
|
||||
2. The **Color** picker auto-fills with that category's color.
|
||||
3. Change the color picker to override per-event — the category definition is unaffected.
|
||||
|
||||
### Type field (combobox)
|
||||
|
||||
The **Type** field in the event modal is a custom combobox:
|
||||
|
||||
- Click the input or toggle button to show all **enabled** categories.
|
||||
- Type to filter the list.
|
||||
- Keyboard navigable (arrow keys, Enter to select, Escape to close).
|
||||
- Selecting a category auto-fills the color picker.
|
||||
- The list closes on selection.
|
||||
Loading…
Reference in a new issue