Skip to content

Commit 16d31db

Browse files
authored
Create README.md
1 parent 6227c6e commit 16d31db

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

README.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
### Magda API docs website
2+
3+
This repository hosts the API documentation content for the [Magda project](https://magda.io), served via **GitHub Pages** at:
4+
5+
🔗 **Live site:** [https://magda-io.github.io/api-docs](https://magda-io.github.io/api-docs)
6+
7+
The content is built from [magda core repo main branch](https://github.com/magda-io/magda).
8+
9+
If you have a deployed version of Magda, you can access the API docs of the deployed version at path `/api/v0/apidocs/index.html`.
10+
11+
## 📘 Structure
12+
13+
The `main` branch contains static HTML files and is used as the source for GitHub Pages.
14+
15+
```text
16+
.
17+
├── index.html # Latest version of the API docs
18+
├── openapi.json # OpenAPI spec
19+
├── openapi.json # Swagger spec

0 commit comments

Comments
 (0)