@csalvato/remarq 1.5.0 → 2.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -1
- package/dist/feedback-layer.js +584 -103
- package/package.json +4 -3
- package/dist/feedback-layer.js.map +0 -7
package/README.md
CHANGED
|
@@ -59,6 +59,7 @@ Configure via data attributes on the script tag:
|
|
|
59
59
|
| `data-api-url` | Yes | - | URL of your Remarq server |
|
|
60
60
|
| `data-content-selector` | No | `"body"` | CSS selector for annotatable content |
|
|
61
61
|
| `data-document-uri` | No | `window.location.pathname` | Unique identifier for this document |
|
|
62
|
+
| `data-theme` | No | `"auto"` | Color theme: `"auto"` (follows OS), `"dark"`, or `"light"` |
|
|
62
63
|
|
|
63
64
|
### Examples
|
|
64
65
|
|
|
@@ -99,10 +100,11 @@ Remarq requires a backend server to store comments.
|
|
|
99
100
|
```bash
|
|
100
101
|
git clone https://github.com/cass-clearly/remarq.git
|
|
101
102
|
cd remarq
|
|
103
|
+
echo "POSTGRES_PASSWORD=remarq" > .env
|
|
102
104
|
docker compose -f docker-compose.remarq.yml up --build
|
|
103
105
|
```
|
|
104
106
|
|
|
105
|
-
This starts Postgres and the Remarq server on `http://localhost:3333`. For production,
|
|
107
|
+
This starts Postgres and the Remarq server on `http://localhost:3333`. For production, use a strong password in your `.env` file — see the [main README](https://github.com/cass-clearly/remarq#production) for details.
|
|
106
108
|
|
|
107
109
|
### API Endpoints
|
|
108
110
|
|