Skip to content

Commit

Permalink
Update README.md for v2.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
jellyterra committed Jun 17, 2024
1 parent 87931c6 commit 5fc64b2
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,10 +59,14 @@ $ cd ~/web/my_site
$ pagine --serve :12450
```

It automatically executes generation when file changes are detected by `inotify`.

> [!NOTE]
> Incremental generation is not implemented yet.<br/>
> Set the `--public` under `/tmp` is recommended to reduce hard disk writes.
Since v2.1.0, the server provides a WebSocket interface at `/ws` to provide event monitoring for the client, such as page updates.

## Structure

### Template
Expand Down Expand Up @@ -180,6 +184,10 @@ define = { title = "Page not found" }
| `unitBase` | Unit's level's base dir path. |
| `templateBase` | It tells the template where it has been stored. |

| Func | Description |
|---------------|-------------------------------------------------------|
| `getMetadata` | It returns the root node of metadata of the template. |

### Data processing

| Func | Args | Result |
Expand Down

0 comments on commit 5fc64b2

Please sign in to comment.