mirror of
https://github.com/netbirdio/docs.git
synced 2026-10-02 11:49:05 +02:00
add first version of tailwind docs
This commit is contained in:
@@ -0,0 +1,34 @@
|
||||
import { SpecLink } from './Spec'
|
||||
import { Url } from 'url'
|
||||
|
||||
export type CliInfo = {
|
||||
id: string
|
||||
version: string
|
||||
title: string
|
||||
language: string
|
||||
source: Url
|
||||
bugs: Url
|
||||
spec: Url
|
||||
description: string
|
||||
options: string
|
||||
}
|
||||
|
||||
export type CliCommand = {
|
||||
id: string
|
||||
title: string
|
||||
summary: string
|
||||
description: string
|
||||
tags: string[]
|
||||
links: SpecLink[]
|
||||
usage: string
|
||||
subcommands: string[]
|
||||
options: string
|
||||
}
|
||||
|
||||
export interface CliSpec {
|
||||
clispec: '001'
|
||||
|
||||
info: CliInfo
|
||||
|
||||
commands: CliCommand[]
|
||||
}
|
||||
@@ -0,0 +1,36 @@
|
||||
import { SpecLink } from './Spec'
|
||||
import { Url } from 'url'
|
||||
|
||||
export type Tag = {
|
||||
id: string
|
||||
title: string
|
||||
description?: string
|
||||
}
|
||||
|
||||
export type ConfigInfo = {
|
||||
id: string
|
||||
version: string
|
||||
title: string
|
||||
source: Url
|
||||
bugs: Url
|
||||
spec: Url
|
||||
description: string
|
||||
tags: Tag[]
|
||||
}
|
||||
|
||||
export type ConfigParameter = {
|
||||
id: string
|
||||
title: string
|
||||
tags: string[]
|
||||
required: boolean
|
||||
description: string
|
||||
links: SpecLink[]
|
||||
}
|
||||
|
||||
export interface ConfigSpec {
|
||||
configspec: '001'
|
||||
|
||||
info: ConfigInfo
|
||||
|
||||
parameters: ConfigParameter[]
|
||||
}
|
||||
@@ -0,0 +1,75 @@
|
||||
import { SpecLink } from './Spec'
|
||||
import { Url } from 'url'
|
||||
|
||||
export type SdkInfo = {
|
||||
id: string
|
||||
version: string
|
||||
title: string
|
||||
language: string
|
||||
source: Url
|
||||
bugs: Url
|
||||
spec: Url
|
||||
description: string
|
||||
options: string
|
||||
}
|
||||
|
||||
export type SdkType = {
|
||||
id: string
|
||||
title: string
|
||||
summary: string
|
||||
source: Url
|
||||
value: string
|
||||
ref?: SdkType
|
||||
links: SpecLink[]
|
||||
}
|
||||
|
||||
export type FunctionAttribute = {
|
||||
id: string
|
||||
title: string
|
||||
required: boolean
|
||||
description: string
|
||||
type?: string[]
|
||||
ref?: string // If a "type" is not supplied, a "ref" must be. This is a pointer to a type.
|
||||
children: FunctionAttribute[]
|
||||
}
|
||||
|
||||
export type FunctionReturn = {
|
||||
id: string
|
||||
title: string
|
||||
value: string
|
||||
description: string
|
||||
ref?: string // This is a pointer to a type.
|
||||
}
|
||||
|
||||
export type FunctionExample = {
|
||||
id: string
|
||||
title: string
|
||||
description?: string
|
||||
links: SpecLink[]
|
||||
code: string
|
||||
returns?: FunctionReturn
|
||||
}
|
||||
|
||||
export type Function = {
|
||||
id: string
|
||||
title: string
|
||||
summary: string
|
||||
source: Url
|
||||
description?: string
|
||||
usage: string
|
||||
tags: string[]
|
||||
links: SpecLink[]
|
||||
attributes?: FunctionAttribute[]
|
||||
returns?: FunctionReturn[]
|
||||
examples?: FunctionExample[]
|
||||
}
|
||||
|
||||
export interface SdkSpec {
|
||||
sdkspec: '001'
|
||||
|
||||
info: SdkInfo
|
||||
|
||||
functions: Function[]
|
||||
|
||||
types: SdkType[]
|
||||
}
|
||||
@@ -0,0 +1,6 @@
|
||||
import { Url } from 'url'
|
||||
|
||||
export type SpecLink = {
|
||||
name: string
|
||||
url: Url
|
||||
}
|
||||
Reference in New Issue
Block a user