Theaninova/openstapps
1
0
Fork 0
mirror of https://gitlab.com/openstapps/openstapps.git synced 2025-12-12 17:26:22 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: add api doc

Browse Source
This commit is contained in:
Thea Schöbl
2023-07-05 11:16:46 +02:00
parent 11c9d742cd
commit 16a039a16e
12 changed files with 115 additions and 1707 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
packages/core/api-doc.html Normal file
View File

@@ -0,0 +1,23 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>OpenStApps API</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<link
href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700"
rel="stylesheet"
/>
<!-- Redoc doesn't change outer page styles -->
<style>
body {
margin: 0;
padding: 0;
}
</style>
</head>
<body>
<redoc spec-url="openapi.json"></redoc>
<script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"></script>
</body>
</html>

2
packages/core/package.json
View File

@@ -32,7 +32,7 @@
"CHANGELOG.md"
],
"scripts": {
"build": "tsup-node --dts && pnpm run mappings && pnpm run schema && pnpm run openapi",
"build": "tsup-node --dts && pnpm run mappings && pnpm run schema && pnpm run openapi && cp api-doc.html lib/api-doc.html",
"docs": "typedoc --json ./docs/docs.json --options ../../typedoc.base.json src/index.ts",
"format": "prettier . -c --ignore-path ../../.gitignore",
"format:fix": "prettier --write . --ignore-path ../../.gitignore",