kubevela/references/docgen/vars.go

38 lines
1.1 KiB
Go

/*
Copyright 2022 The KubeVela Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package docgen
const (
// Markdown marks the format name of docs
Markdown = "markdown"
// Console marks the format name of docs
Console = "console"
)
const (
// Specification marks the title of parameter in reference docs
Specification = "Specification"
// Description marks the title of description in reference docs
Description = "Description"
// Scope marks the title of scope in reference docs
Scope = "Scope"
// Examples marks the title of example in reference doc
Examples = "Examples"
// Base is the title of base in reference doc
Base = "Underlying Kubernetes Resources"
)