Skip to content

Commit a2491ff

Browse files
authored
docs: correct README following markdown rules (#8024)
1 parent 5e15864 commit a2491ff

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,7 @@ Before you start make sure you have installed:
111111
### Compatibility
112112

113113
#### Node.js
114+
114115
Parse Server is continuously tested with the most recent releases of Node.js to ensure compatibility. We follow the [Node.js Long Term Support plan](https://github.com/nodejs/Release) and only test against versions that are officially supported and have not reached their end-of-life date.
115116

116117
| Version | Latest Version | End-of-Life | Compatible |
@@ -122,6 +123,7 @@ Parse Server is continuously tested with the most recent releases of Node.js to
122123
| Node.js 18 | 18.1.0 | April 2025 | ✅ Yes |
123124

124125
#### MongoDB
126+
125127
Parse Server is continuously tested with the most recent releases of MongoDB to ensure compatibility. We follow the [MongoDB support schedule](https://www.mongodb.com/support-policy) and only test against versions that are officially supported and have not reached their end-of-life date.
126128

127129
| Version | Latest Version | End-of-Life | Compatible |
@@ -134,6 +136,7 @@ Parse Server is continuously tested with the most recent releases of MongoDB to
134136
| MongoDB 5.2 | 5.2.1 | TBD | ✅ Yes |
135137

136138
#### PostgreSQL
139+
137140
Parse Server is continuously tested with the most recent releases of PostgreSQL and PostGIS to ensure compatibility, using [PostGIS docker images](https://registry.hub.docker.com/r/postgis/postgis/tags?page=1&ordering=last_updated). We follow the [PostgreSQL support schedule](https://www.postgresql.org/support/versioning) and [PostGIS support schedule](https://www.postgis.net/eol_policy/) and only test against versions that are officially supported and have not reached their end-of-life date. Due to the extensive PostgreSQL support duration of 5 years, Parse Server drops support if a version is older than 3.5 years and a newer version has been available for at least 2.5 years.
138141

139142
| Version | PostGIS Version | End-of-Life | Parse Server Support End | Compatible |
@@ -144,6 +147,7 @@ Parse Server is continuously tested with the most recent releases of PostgreSQL
144147
| Postgres 14 | 3.2 | November 2026 | April 2025 | ✅ Yes |
145148

146149
### Locally
150+
147151
```bash
148152
$ npm install -g parse-server mongodb-runner
149153
$ mongodb-runner start
@@ -236,7 +240,6 @@ $ curl -X GET \
236240
}
237241
]
238242
}
239-
240243
```
241244

242245
To learn more about using saving and querying objects on Parse Server, check out the [Parse documentation](http://docs.parseplatform.org).
@@ -386,6 +389,7 @@ const server = ParseServer({
386389
```
387390

388391
## Custom Routes
392+
389393
**Caution, this is an experimental feature that may not be appropriate for production.**
390394

391395
Custom routes allow to build user flows with webpages, similar to the existing password reset and email verification features. Custom routes are defined with the `pages` option in the Parse Server configuration:
@@ -418,6 +422,7 @@ The above route can be invoked by sending a `GET` request to:
418422
The `handler` receives the `request` and returns a `custom_page.html` webpage from the `pages.pagesPath` directory as response. The advantage of building a custom route this way is that it automatically makes use of Parse Server's built-in capabilities, such as [page localization](#pages) and [dynamic placeholders](#dynamic-placeholders).
419423
420424
### Reserved Paths
425+
421426
The following paths are already used by Parse Server's built-in features and are therefore not available for custom routes. Custom routes with an identical combination of `path` and `method` are ignored.
422427

423428
| Path | HTTP Method | Feature |
@@ -513,6 +518,7 @@ Identical requests are identified by their request header `X-Parse-Request-Id`.
513518
Deduplication is only done for object creation and update (`POST` and `PUT` requests). Deduplication is not done for object finding and deletion (`GET` and `DELETE` requests), as these operations are already idempotent by definition.
514519
515520
### Configuration example <!-- omit in toc -->
521+
516522
```
517523
let api = new ParseServer({
518524
idempotencyOptions: {
@@ -521,6 +527,7 @@ let api = new ParseServer({
521527
}
522528
}
523529
```
530+
524531
### Parameters <!-- omit in toc -->
525532
526533
| Parameter | Optional | Type | Default value | Example values | Environment variable | Description |
@@ -553,6 +560,7 @@ Assuming the script above is named, `parse_idempotency_delete_expired_records.sh
553560
## Localization
554561
555562
### Pages
563+
556564
**Caution, this is an experimental feature that may not be appropriate for production.**
557565
558566
Custom pages as well as feature pages (e.g. password reset, email verification) can be localized with the `pages` option in the Parse Server configuration:

0 commit comments

Comments
 (0)