{"id":13550973,"url":"https://github.com/MkDocsEditor/MkDocsEditor-Backend","last_synced_at":"2025-04-03T01:30:55.660Z","repository":{"id":128408371,"uuid":"165250470","full_name":"MkDocsEditor/MkDocsEditor-Backend","owner":"MkDocsEditor","description":"Server backend for MkDocsEditor clients.","archived":false,"fork":false,"pushed_at":"2024-07-30T22:08:20.000Z","size":218,"stargazers_count":5,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-08-01T12:23:24.810Z","etag":null,"topics":["collaborative-editing","differential-synchronization","go","golang","hacktoberfest","mkdocs","realtime-collaboration","realtime-editing","websocket-server"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MkDocsEditor.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-01-11T13:45:01.000Z","updated_at":"2024-07-30T22:08:23.000Z","dependencies_parsed_at":"2024-01-21T01:27:46.781Z","dependency_job_id":"d3642fb7-2f2f-4a2c-ad16-7fd8789244c0","html_url":"https://github.com/MkDocsEditor/MkDocsEditor-Backend","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MkDocsEditor%2FMkDocsEditor-Backend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MkDocsEditor%2FMkDocsEditor-Backend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MkDocsEditor%2FMkDocsEditor-Backend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MkDocsEditor%2FMkDocsEditor-Backend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MkDocsEditor","download_url":"https://codeload.github.com/MkDocsEditor/MkDocsEditor-Backend/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":222905604,"owners_count":17055816,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["collaborative-editing","differential-synchronization","go","golang","hacktoberfest","mkdocs","realtime-collaboration","realtime-editing","websocket-server"],"created_at":"2024-08-01T12:01:40.552Z","updated_at":"2024-11-03T21:30:44.903Z","avatar_url":"https://github.com/MkDocsEditor.png","language":"Go","funding_links":[],"categories":["Go","golang"],"sub_categories":[],"readme":"# MkDocsEditor-Backend\n\nServer backend for MkDocsEditor clients.\n\n## How to use\n\n### Configuration\n\nCreate a `mkdocsrest.yaml` file similar to the [mkdocsrest_example.yaml](mkdocsrest_example.yaml).\n\n### Docker\n\nRun the service using Docker and mount the configuration file and the wiki folder:\n\n```bash\ndocker run -d \\\n    -p 7413:7413 \\\n    -v ~/mkdocsrest.yaml:/app/mkdocsrest.yaml \\\n    -v ~/mywiki:/data \\\n    ghcr.io/mkdocseditor/mkdocseditor-backend:latest\n```\n\n### Connect\n\nUse a client to connect to the service.\n\n## Clients\n\n- [MkDocsEditor-Android](https://github.com/MkDocsEditor/MkDocsEditor-Android)\n- [MkDocsEditor-Web](https://github.com/MkDocsEditor/MkDocsEditor-Web)\n\n## API\n\n[OpenAPI Documentation](https://editor-next.swagger.io/?url=https://raw.githubusercontent.com/MkDocsEditor/MkDocsEditor-Backend/master/openapi-description.yaml)\n\n### General\n\n| Method | Path           | Description                                 |\n|--------|----------------|---------------------------------------------|\n| GET    | /alive         | Liveness probe endpoint                     |\n| GET    | /mkdocs/config | Retrieve the `mkdocsrest.yaml` configurtion |\n\n### Sections\n\n| Method | Path                 | Description                                           |\n|--------|----------------------|-------------------------------------------------------|\n| GET    | /section             | Retrieve the whole section tree                       |\n| GET    | /section/\u003csectionId\u003e | Retrieve the section with the given `sectionId`       |\n| POST   | /section             | Create a new secton                                   |\n| PUT    | /section/\u003csectionId\u003e | Update an existing section with the given `sectionId` |\n| DELETE | /section/\u003csectionId\u003e | Delete the section with the given `sectionId`         |\n\n### Documents\n\n| Method | Path                           | Description                                                                                                 |\n|--------|:-------------------------------|-------------------------------------------------------------------------------------------------------------|\n| GET    | /document/\u003cdocumentId\u003e         | Retrieve the document with the given `documentId`                                                           |\n| GET    | /document/\u003cdocumentId\u003e/ws      | Websocket endpoint for realtime communication regarding updates of the document with the given `documentId` |\n| GET    | /document/\u003cdocumentId\u003e/content | Retrieve the current content of the document with the given `documentId`                                    |\n| POST   | /document                      | Create a new document                                                                                       |\n| PUT    | /document/\u003cdocumentId\u003e         | Rename an exsiting document with the given `documentId`                                                     |\n| DELETE | /document/\u003cdocumentId\u003e         | Delete the document with the given `documentId`                                                             |\n\n### Resources\n\n| Method | Path                           | Description                                                              |\n|--------|--------------------------------|--------------------------------------------------------------------------|\n| GET    | /resource/\u003cresourceId\u003e         | Retrieve the resource with the given `resourceId`                        |\n| GET    | /resource/\u003cresourceId\u003e/content | Retrieve the current content of the resource with the given `resourceId` |\n| POST   | /resource                      | Upload a new resource                                                    |\n| PUT    | /resource/\u003cresourceId\u003e         | Rename an exsiting resource with the given `resourceId`                  |\n| DELETE | /resource/\u003cresourceId\u003e         | Delete the resource with the given `resourceId`                          |\n\n# Contributing\n\nGitHub is for social coding: if you want to write code, I encourage\ncontributions through pull requests from forks of this repository.\nCreate GitHub tickets for bugs and new features and comment on the ones\nthat you are interested in.\n\n# License\n\nAGPLv3+\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMkDocsEditor%2FMkDocsEditor-Backend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FMkDocsEditor%2FMkDocsEditor-Backend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMkDocsEditor%2FMkDocsEditor-Backend/lists"}