github.com/oam-dev/kubevela@v1.9.11/references/docgen/vars.go (about)

     1  /*
     2   Copyright 2022 The KubeVela Authors.
     3  
     4   Licensed under the Apache License, Version 2.0 (the "License");
     5   you may not use this file except in compliance with the License.
     6   You may obtain a copy of the License at
     7  
     8   	http://www.apache.org/licenses/LICENSE-2.0
     9  
    10   Unless required by applicable law or agreed to in writing, software
    11   distributed under the License is distributed on an "AS IS" BASIS,
    12   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13   See the License for the specific language governing permissions and
    14   limitations under the License.
    15  */
    16  
    17  package docgen
    18  
    19  const (
    20  	// Markdown marks the format name of docs
    21  	Markdown = "markdown"
    22  	// Console marks the format name of docs
    23  	Console = "console"
    24  )
    25  
    26  const (
    27  	// Specification marks the title of parameter in reference docs
    28  	Specification = "Specification"
    29  	// Description marks the title of description in reference docs
    30  	Description = "Description"
    31  	// Scope marks the title of scope in reference docs
    32  	Scope = "Scope"
    33  	// Examples marks the title of example in reference doc
    34  	Examples = "Examples"
    35  	// Base is the title of base in reference doc
    36  	Base = "Underlying Kubernetes Resources"
    37  )