External/domain-watchdog
1
0
Fork 0
mirror of https://github.com/maelgangloff/domain-watchdog.git synced 2025-12-29 16:15:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: add API section in the documentation

Browse Source
This commit is contained in:
Maël Gangloff
2025-12-02 21:16:44 +01:00
parent 9466b4985c
commit 14937f3ded
6 changed files with 155 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
docs/astro.config.mjs
View File

@@ -5,7 +5,10 @@ import starlightLinksValidator from 'starlight-links-validator'
import mermaid from "astro-mermaid"
import starlightCoolerCredit from "starlight-cooler-credit"
import starlightKbd from 'starlight-kbd'
import starlightOpenAPI, {createOpenAPISidebarGroup} from 'starlight-openapi'
const domainWatchdogSidebarGroup = createOpenAPISidebarGroup()
const BASE_URL = 'https://domainwatchdog.eu'
// https://astro.build/config
@@ -62,9 +65,10 @@ export default defineConfig({
{label: 'Contributing', autogenerate: {directory: 'developing/contributing'}, translations: {fr: 'Contribuer'}}
],
},
{label: 'Definitions', autogenerate: {directory: 'definitions'}, collapsed: true, translations: {fr: 'Définitions'}},
{label: 'Interoperability', items: [domainWatchdogSidebarGroup], badge: {text: 'DEV', class: 'caution'}, collapsed: true},
{label: 'Legal', autogenerate: {directory: 'legal'}, collapsed: true, translations: {fr: 'Légal'}},
{slug: 'acknowledgment', translations: {fr: 'Remerciements'}},
{label: 'Definitions', autogenerate: {directory: 'definitions'}, collapsed: true, translations: {fr: 'Définitions'}},
],
locales: {
en: {
@@ -150,6 +154,13 @@ _paq.push(['enableHeartBeatTimer']);
{id: 'mac', label: 'macOS'}
],
}),
starlightOpenAPI([
{
base: 'interoperability/api',
schema: 'swagger_docs.json',
sidebar: {operations: {badges: true}, group: domainWatchdogSidebarGroup}
},
]),
],
customCss: [
'./src/styles/index.css'