luxick/datascape
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update Readme

Browse Source
This commit is contained in:
luxick
2026-05-08 10:16:40 +02:00
parent ba10fd2573
commit 33180c8be8
1 changed files with 22 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+22 -14
View File
@@ -2,12 +2,17 @@
Minimal self-hosted personal wiki. Folders are pages. Minimal self-hosted personal wiki. Folders are pages.
## Run ## Features
```bash - **Pages** every folder is a page. Place an `index.md` inside a folder and it renders as HTML. Drop any other files (PDFs, images, etc.) alongside it and they appear in the listing below the content. Navigating to a path that does not exist shows a **[CREATE]** prompt.
go run . -dir ./wiki -addr :8080
go run . -dir ./wiki -addr :8080 -user me -pass secret - **Search** search across all page names (folder names) in the wiki, accessible from the navigation bar.
```
- **Wikilinks** link between pages with `[[Page Name]]` syntax. When a page is renamed or moved, all wikilinks pointing to it are rewritten automatically to reflect the new path.
- **Movie import** import movie entries via the OMDb API. Fetches title, year, runtime, genre, director, cast, plot, and poster, and pre-fills a new page with that metadata.
- **Special folder types** folders can opt into custom rendering (e.g. a photo diary with calendar navigation). See the [Special Folder Types](#special-folder-types) section for details.
## Build ## Build
@@ -21,16 +26,19 @@ GOOS=linux GOARCH=arm go build -o datascape .
## Usage ## Usage
| Action | How | ```bash
|--------|-----| go run . -dir ./wiki -addr :8080
| Browse | Navigate folders at `/` | go run . -dir ./wiki -addr :8080 -user me -pass secret
| Read | Any folder with `index.md` renders it as HTML | ```
| 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. | Flag | Default | Description |
|------|---------|-------------|
| `-addr` | `:8080` | Listen address |
| `-dir` | `./wiki` | Wiki root directory |
| `-cache` | `./cache` | Thumbnail cache directory |
| `-user` | _(none)_ | Basic auth username — omit to disable auth |
| `-pass` | _(none)_ | Basic auth password |
| `-reindex-interval` | `30m` | Periodic search index rebuild interval (`0` disables) |
## Special Folder Types ## Special Folder Types