Initial version
This commit is contained in:
30
README.md
Normal file
30
README.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# datascape
|
||||
|
||||
Minimal self-hosted personal wiki. Folders are pages.
|
||||
|
||||
## Run
|
||||
|
||||
```bash
|
||||
go run . -dir ./wiki -addr :8080
|
||||
go run . -dir ./wiki -addr :8080 -user me -pass secret
|
||||
```
|
||||
|
||||
## Build
|
||||
|
||||
```bash
|
||||
# local
|
||||
go build -o datascape .
|
||||
|
||||
# QNAP NAS (linux/arm64)
|
||||
GOOS=linux GOARCH=arm64 go build -o datascape .
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
| Action | How |
|
||||
|--------|-----|
|
||||
| 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 |
|
||||
| Files | Drop PDFs, images, etc. next to `index.md` — they appear in the listing |
|
||||
Reference in New Issue
Block a user