Server backend for MkDocsEditor clients.
Create a mkdocsrest.yaml file similar to the mkdocsrest_example.yaml.
Run the service using Docker and mount the configuration file and the wiki folder:
docker run -d \
-p 7413:7413 \
-v ~/mkdocsrest.yaml:/app/mkdocsrest.yaml \
-v ~/mywiki:/data \
ghcr.io/mkdocseditor/mkdocseditor-backend:latestUse a client to connect to the service.
| Method | Path | Description |
|---|---|---|
| GET | /alive | Liveness probe endpoint |
| GET | /mkdocs/config | Retrieve the mkdocsrest.yaml configuration |
| Method | Path | Description |
|---|---|---|
| GET | /section | Retrieve the whole section tree |
| GET | /section/ | Retrieve the section with the given sectionId |
| POST | /section | Create a new section |
| PUT | /section/ | Update an existing section with the given sectionId |
| DELETE | /section/ | Delete the section with the given sectionId |
| Method | Path | Description |
|---|---|---|
| GET | /document/ | Retrieve the document with the given documentId |
| GET | /document//ws | Websocket endpoint for realtime communication regarding updates of the document with the given documentId |
| GET | /document//content | Retrieve the current content of the document with the given documentId |
| POST | /document | Create a new document |
| PUT | /document/ | Rename an existing document with the given documentId |
| DELETE | /document/ | Delete the document with the given documentId |
| Method | Path | Description |
|---|---|---|
| GET | /resource/ | Retrieve the resource with the given resourceId |
| GET | /resource//content | Retrieve the current content of the resource with the given resourceId |
| POST | /resource | Upload a new resource |
| PUT | /resource/ | Rename an existing resource with the given resourceId |
| DELETE | /resource/ | Delete the resource with the given resourceId |
GitHub is for social coding: if you want to write code, I encourage contributions through pull requests from forks of this repository. Create GitHub tickets for bugs and new features and comment on the ones that you are interested in.
AGPLv3+