Update README and AGENTS
This commit is contained in:
37
README.md
37
README.md
@@ -25,6 +25,39 @@ GOOS=linux GOARCH=arm go build -o datascape .
|
||||
|--------|-----|
|
||||
| Browse | Navigate folders at `/` |
|
||||
| Read | Any folder with `index.md` renders it as HTML |
|
||||
| Edit | Append `?edit` to any folder URL, or click **Edit** |
|
||||
| Save | POST from the edit form writes `index.md` to disk |
|
||||
| Edit | Append `?edit` to any folder URL, or click **[EDIT]** (Alt+Shift+E) |
|
||||
| Save | POST from the edit form writes `index.md` to disk; folder is created if needed |
|
||||
| New page | Click **[NEW]** (Alt+Shift+N), enter a name — opens the new page in edit mode |
|
||||
| Files | Drop PDFs, images, etc. next to `index.md` — they appear in the listing |
|
||||
|
||||
Navigating to a URL that does not exist shows an empty page with a **[CREATE]** prompt.
|
||||
|
||||
## Special Folder Types
|
||||
|
||||
A folder can opt into special rendering by adding a `.page-settings` file:
|
||||
|
||||
```
|
||||
type = diary
|
||||
```
|
||||
|
||||
### Diary
|
||||
|
||||
Designed for a chronological photo diary. Expected structure:
|
||||
|
||||
```
|
||||
FolderName/
|
||||
.page-settings ← type = diary
|
||||
YYYY/
|
||||
YYYY-MM-DD Desc.jpg ← photos named with date prefix
|
||||
MM/
|
||||
DD/
|
||||
index.md ← diary entry for that day
|
||||
```
|
||||
|
||||
| View | What renders |
|
||||
|------|-------------|
|
||||
| Year (`YYYY/`) | Section per month with link and photo count |
|
||||
| Month (`MM/`) | Section per day with entry content and photo grid |
|
||||
| Day (`DD/`) | Entry content and photo grid |
|
||||
|
||||
Days with photos but no `index.md` still appear in the month view and can be created by clicking their heading link.
|
||||
|
||||
Reference in New Issue
Block a user