vss-extension.json

description: Valid URI

title: Valid file path in the extension

description: A contribution that is part of this extension

required: id type targets

title: Referencing contributions and types => https://docs.microsoft.com/en-us/azure/devops/extend/develop/manifest?view=azure-devops#contributionIds

description: A reference ID (string) for the contribution. Each contribution's ID must be unique within an extension.

description: The ID of the contributionType of this contribution.

description: (Optional) A string describing what the contribution is providing.

description: An array of contribution IDs that the contribution is targeting (contributing to).

title: Targeting Contributions: https://docs.microsoft.com/en-us/azure/devops/extend/develop/manifest?view=azure-devops#targeting-contributions

description: Contribution IDs that the contribution is targeting.

description: Valid Values: https://docs.microsoft.com/en-us/azure/devops/extend/develop/public-project?view=azure-devops#contribution-visibility

title: Contribution visibility: By default, contributions are only visible to organization members. To give non-member users visibility to a contribution, set the restrictedTo attribute on that contribution. The value is a string array that lists which types of users should have visibility to the contribution

enum: member public anonymous

description: (Optional) An object that includes properties for the contribution as defined in the contribution type.

title: For more information, see the contribution model overview => https://docs.microsoft.com/en-us/azure/devops/extend/develop/contributions-overview?view=azure-devops

description: A contribution Type that is part of this extension

required: id name

description: A reference ID (string) for the contribution type. Each contribution type's ID must be unique within an extension.

description: The friendly name of the contribution type.

description: (Optional) A string describing in more detail what the contribution type is for.

description: (Optional) A dictionary that maps property names to property descriptions. These properties describe the required and optional properties that can be used by contributions of this type.

description: Information about the contributionType Property

description: The type of value that the property can have.

enum: string uri guid boolean integer double dateTime array object

description: (Optional) A boolean value which if true indicates that the property is required for all contributions of this type.

description: (Optional) A string describing what the property is used for.

title: A number corresponding to the version of the manifest format.

description: This should be 1.

title: The extension's identifier

description: This is a string that must be unique among extensions from the same publisher.

title: A string specifying the version of an extension.

description: Should be in the format major.minor.patch, for example 0.1.2 or 1.0.0. You can also add a fourth number for the following format: 0.1.2.3

title: A short, human-readable name of the extension. Limited to 200 characters.

examples:
Azure DevOps Extension Tasks
Fabrikam Agile Board Extension

title: The identifier of the publisher.

description: This identifier must match the identifier the extension is published under.

title: Array of strings representing the categories your extension belongs to.

description: At least one category must be provided and there is no limit to how many categories you may include.

enum:
Azure Repos
Azure Boards
Azure Pipelines
Azure Test Plans
Azure Artifacts

title: The products and services supported by your integration or extension.

title: Installation targets: https://docs.microsoft.com/en-us/azure/devops/extend/develop/manifest?view=azure-devops#installation-targets

description: Id of the product or service which your integration/extension should support

title: Installation target versions: https://docs.microsoft.com/en-us/azure/devops/extend/develop/manifest?view=azure-devops#installation-targets

description: Some installation target identifiers, like and , support an optional version range. This further clarifies the supported releases the extension or integration is supported on.Microsoft.TeamFoundation.ServerMicrosoft.TeamFoundation.Server.Integration

title: Authorization scopes required by your extension.

description: An array of authorization scopes (strings) listing permissions required by your extension.

description: Authorization Scope.

title: Valid Values: https://docs.microsoft.com/en-us/azure/devops/extend/develop/manifest?view=azure-devops#scopes

title: Capabilities required by your extension.

description: An array of demands (strings) listing the capabilities required by your extension.

description: Demand Scope.

title: Valid Values: https://docs.microsoft.com/en-us/azure/devops/extend/develop/manifest?view=azure-devops#demands

description: (Optional) base URL for all relative URLs specified by the extension's contributions.

title: This property should be left empty if your extension's contents are packaged with your extension.

title: A few sentences describing the extension.

description: Dictionary of icons representing the extension.

title: (128x128 pixels) of type BMP, GIF, EXIF, JPG, PNG and TIFF.

description: The value must be the path to the icon file in the extension

description: Array of string tags to help users find your extension.

description: A tag to help users find your extension.

examples:
Extension
Marketplace
Publish
Package
Install
Continuous Integration
Continuous Delivery
Build
Release
Azure Pipelines
Azure DevOps Extensions
Visual Studio Extensions
__BYOLENFORCED
__DoNotDownload

description: Array of string tags to classify your extension within the Visual Studio Marketplace

description: A string tag to classify your extension within the Visual Studio Marketplace

enum: Paid Preview Public

description: More information: https://docs.microsoft.com/en-us/azure/devops/extend/develop/manifest?view=azure-devops#mark-an-extension-as-paid

title: Screenshots are more valuable when featured in your content, and should be used there to help make a quality market details page for your extension. Use screenshots for less important images not featured in your content.

description: Array of images that could not be included in your **content*.

title: An image that could not be included in your **content*.

description: Each image should be 1366x768 pixels.

title: Each image should be 1366x768 pixels.

description: The path of each item is the path to the file in the extension.

title: Dictionary of content files that describe your extension to users.

title: Extension Details (GitHub Flavored Markdown File)

description: GitHub Flavored Markdown file which describes the details of the Extension

title: Extension License Information (GitHub Flavored Markdown File)

description: GitHub Flavored Markdown file which describes the license information of the Extension

title: Extension Pricing Information (GitHub Flavored Markdown File)

description: GitHub Flavored Markdown file which describes the pricing information of the Extension

title: Dictionary of links that help users learn more about your extension, get support, and move.

title: Get Started Documentation (GitHub Flavored Markdown File)

description: First steps, how to setup or use.

title: Learning Documentation (GitHub Flavored Markdown File)

description: Deeper content to help users better understand your extension or service.

title: License Documentation (GitHub Flavored Markdown File)

description: End user license agreement.

title: Privacy Policy (GitHub Flavored Markdown File)

description: Privacy policy for an extension.

title: Support Information (GitHub Flavored Markdown File)

description: Get help and support for an extension.

title: The source code repository for the extension

required: type uri

title: Type of the repository

enum: git mercurial svn cvs

title: Absolute URI of the repository

description: Array of links to external metadata badges like TravisCI, Appveyor etc from the approved badges sites.

title: Approved Badge Sites: https://docs.microsoft.com/en-us/azure/devops/extend/develop/manifest.#approvedbadges

title: Badge Information

required: href uri

description: Link the user navigates to when clicking the badge.

description: The absolute URL of the badge image to be displayed.

title: Description of the badge, to be displayed on hover.

description: Dictionary of brand-related properties.

description: Primary color of the extension or publisher; can be a hex (#ff00ff), RGB (rgb(100,200,50)), or supported HTML color names (blue).

description: Complements the color; use dark for dark branding colors, or light for lighter branding colors.

enum: light dark

description: Set to true to make this extension public in the Visual Studio Market Place

title: The files section is where you reference any files you wish to include in your extension. You can add both folders and individual files.

description: A file you wish to include in your extension. Both folders and individual files are acceptable

description: Path of resource, root directory is where your manifest file is located

description: Set to true if you want your file to be URL-addressable

description: Places your resource from disk to the specified value when packaged

title: An array of contributions to the system.

title: An array of contribution types defined by the extension

required: manifestVersion id version name publisher categories targets

title: JSON Schema for Azure DevOps Extensions


hugo.json

type: array

type: string

type: object

title: output format options

description:
The output format options
https://gohugo.io/templates/output-formats/#configure-output-formats

description:
The identifier
https://gohugo.io/templates/output-formats/#configure-output-formats

description:
The media type
https://gohugo.io/templates/output-formats/#configure-output-formats

enum: application/javascript application/json application/manifest+json application/octet-stream application/pdf application/rss+xml application/toml application/typescript application/xml application/yaml font/otf font/ttf image/bmp image/gif image/jpeg image/png image/svg+xml image/webp text/calendar text/css text/csv text/html text/jsx text/plain text/tsx text/x-sass text/x-scss video/3gpp video/mp4 video/mpeg video/ogg video/webm video/x-msvideo

description:
The path
https://gohugo.io/templates/output-formats/#configure-output-formats

description:
The base filename for the list filenames
https://gohugo.io/templates/output-formats/#configure-output-formats

default: index

default: alternate

description:
The replacement for `http://` or `https://` in `baseURL`
https://gohugo.io/templates/output-formats/#configure-output-formats

description:
Enable/disable Go's plain text templates parser for the templates
https://gohugo.io/templates/output-formats/#configure-output-formats

type: boolean

description:
Enable/disable adding file extensions to urls
https://gohugo.io/templates/output-formats/#configure-output-formats

description:
Include/exclude this format in an AlternativeOutputFormats format listing
https://gohugo.io/templates/output-formats/#configure-output-formats

description:
Enable/disable .Permalink and .RelPermalink return the rendering output format
https://gohugo.io/templates/output-formats/#configure-output-formats

description:
The weight
https://gohugo.io/templates/output-formats/#configure-output-formats

type: integer

description:
The aliases
https://gohugo.io/content-management/front-matter#predefined

$ref: #/definitions/uniqueStringArray

description:
The audio
https://gohugo.io/content-management/front-matter#predefined

description:
The datetime
https://gohugo.io/content-management/front-matter#predefined

description:
The description
https://gohugo.io/content-management/front-matter#predefined

description:
Specify that the content is (not) the draft
https://gohugo.io/content-management/front-matter#predefined

description:
The expire date
https://gohugo.io/content-management/front-matter#predefined

description:
Specify that the content is (not) the headless bundle
https://gohugo.io/content-management/front-matter#predefined

description:
The images
https://gohugo.io/content-management/front-matter#predefined

description:
Specify that the page language is (not) the CJK language
https://gohugo.io/content-management/front-matter#predefined

description:
The keywords
https://gohugo.io/content-management/front-matter#predefined

description:
The layout
https://gohugo.io/content-management/front-matter#predefined

description:
The last modification time
https://gohugo.io/content-management/front-matter#predefined

description:
The link title
https://gohugo.io/content-management/front-matter#predefined

enum: rst md

title: output format options

description:
The output format options
https://gohugo.io/content-management/front-matter#predefined

description:
The publish date
https://gohugo.io/content-management/front-matter#predefined

title: resource options

description:
The resource options
https://gohugo.io/content-management/front-matter#predefined

description:
The value for `Name`
https://gohugo.io/content-management/page-resources/#page-resources-metadata

description:
The value for `Title`
https://gohugo.io/content-management/page-resources/#page-resources-metadata

title: param options

description:
The param options
https://gohugo.io/content-management/page-resources/#page-resources-metadata

description:
The param
https://gohugo.io/content-management/page-resources/#page-resources-metadata

description:
The series
https://gohugo.io/content-management/front-matter#predefined

description:
The slug
https://gohugo.io/content-management/front-matter#predefined

description:
The summary
https://gohugo.io/content-management/front-matter#predefined

description:
The title
https://gohugo.io/content-management/front-matter#predefined

description:
The type
https://gohugo.io/content-management/front-matter#predefined

description:
The url
https://gohugo.io/content-management/front-matter#predefined

description:
The videos
https://gohugo.io/content-management/front-matter#predefined

description:
The weight
https://gohugo.io/content-management/front-matter#predefined

description:
The front matter default
https://gohugo.io/content-management/front-matter#front-matter-cascade

description:
The directory to store archetype files
https://gohugo.io/getting-started/configuration/#archetypedir

default: archetypes

description:
The directory to store asset files
https://gohugo.io/getting-started/configuration/#assetdir

default: assets

description:
The hostname and the path to the root
https://gohugo.io/getting-started/configuration/#baseurl

title: build options

description:
The build options
https://gohugo.io/getting-started/configuration/#configure-build

description:
The time when to use the cached resources in `/resources/_gen` for `PostCSS` and `ToCSS`
https://gohugo.io/getting-started/configuration/#configure-build

default: fallback

enum: never always fallback

description:
Enable/disable `hugo_stats.json` writing to the root project directory
https://gohugo.io/getting-started/configuration/#configure-build

description:
Enable/disable `jsconfig.json` writing into your `/assets` folder with mapping of imports from running `js.Build`
https://gohugo.io/getting-started/configuration/#configure-build

description:
Include/exclude the drafts when building
https://gohugo.io/getting-started/configuration/#builddrafts-false

description:
Include/exclude the content already expired
https://gohugo.io/getting-started/configuration/#buildexpired

description:
Include/exclude the content with `publishDate` in the future
https://gohugo.io/getting-started/configuration/#buildfuture

title: cache options

description:
The cache options
https://gohugo.io/getting-started/configuration/#configure-file-caches

dir: :cacheDir/modules

description: Cache entry

description:
The duration before the cache entry will be evicted
https://gohugo.io/getting-started/configuration/#the-keywords-explained

description:
The absolute path to store cache files
https://gohugo.io/getting-started/configuration/#the-keywords-explained

examples: :cacheDir :project :resourceDir :resourceDir/_gen :cacheDir/:project :cacheDir/modules

title: front matter options

description:
The front matter options
https://gohugo.io/content-management/front-matter#front-matter-cascade

$ref: #/definitions/cascade

description:
The front matter default
https://gohugo.io/content-management/front-matter#front-matter-cascade

description:
The glob pattern matching the content path below /content
https://gohugo.io/content-management/front-matter#front-matter-cascade

description:
The glob pattern matching the page's kind
https://gohugo.io/content-management/front-matter#front-matter-cascade

description:
The glob pattern matching the page's language
https://gohugo.io/content-management/front-matter#front-matter-cascade

description:
Enable/disable relative URLs to absolute conversion
https://gohugo.io/getting-started/configuration/#canonifyurls

description:
The directory where content files are stored
https://gohugo.io/getting-started/configuration/#contentdir

default: content

description:
The copyright notice for your site
https://gohugo.io/getting-started/configuration/#copyright

description:
The directory where data files are stored
https://gohugo.io/getting-started/configuration/#datadir

default: data

description:
The default content language for the content without language indicator
https://gohugo.io/getting-started/configuration/#defaultcontentlanguage

default: en

description:
Enable/disable rendering the default content language in subdir
https://gohugo.io/getting-started/configuration/#defaultcontentlanguageinsubdir

description:
Enable/disable generation of the alias redirects
https://gohugo.io/getting-started/configuration/#disablealiases

description:
Enable/disable injecting a generator meta tag in the HTML head on the home page only
https://gohugo.io/getting-started/configuration/#disablehugogeneratorinject

description:
Disabled kinds of pages
https://gohugo.io/getting-started/configuration/#disablekinds

enum: page home section taxonomy term RSS sitemap robotsTXT 404

description:
Enable/disable automatic live reloading of browser window
https://gohugo.io/getting-started/configuration/#disablelivereload

description:
Enable/disable the url/path to lowercase conversion
https://gohugo.io/getting-started/configuration/#disablepathtolower

description:
Enable/disable Emoji emoticons support for page content
https://gohugo.io/getting-started/configuration/#enableemoji

description:
Enable/disable .GitInfo object for each page
https://gohugo.io/getting-started/configuration/#enablegitinfo

description:
Enable/disable inline shortcode support
https://gohugo.io/getting-started/configuration/#enableinlineshortcodes

description:
Enable/disable placeholder substitution instead of the default value or an empty string if a translation is missing
https://gohugo.io/getting-started/configuration/#enablemissingtranslationplaceholders

description:
Enable/disable generation of robots.txt file
https://gohugo.io/getting-started/configuration/#enablerobotstxt

title: front matter options

description:
The front matter options
https://gohugo.io/getting-started/configuration/#configure-front-matter

date: date publishDate lastmod

lastmod: :git lastmod date publishDate

enum: date publishDate lastmod :default :filename :git modified pubdate

enum: :git lastmod date publishDate :fileModTime modified pubdate

description:
The prefix for footnote anchors
https://gohugo.io/getting-started/configuration/#footnoteanchorprefix

description:
The text to display for footnote return links
https://gohugo.io/getting-started/configuration/#footnotereturnlinkcontents

description:
The Google Analytics tracking ID
https://gohugo.io/getting-started/configuration/#googleanalytics

description:
Enable/disable auto-detecting Chinese/Japanese/Korean Languages in the content
https://gohugo.io/getting-started/configuration/#hascjklanguage

description:
The image processing options
https://gohugo.io/getting-started/configuration/#imaging

description:
The default resample filter
https://gohugo.io/content-management/image-processing/#resampling-filter

enum: NearestNeighbor Box Linear Hermite MitchellNetravali CatmullRom BSpline Gaussian Lanczos Hann Hamming Blackman Bartlett Welch Cosine

description:
The default quality
https://gohugo.io/content-management/image-processing/#image-processing-config

description:
The default hint about what type of image
https://gohugo.io/content-management/image-processing/#image-processing-config

description:
The anchor used when cropping pictures with either .Fill or .Crop
https://gohugo.io/content-management/image-processing/#image-processing-config

enum: Smart TopLeft Top TopRight Left Center Right BottomLeft Bottom BottomRight

description:
The default background color
https://gohugo.io/content-management/image-processing/#image-processing-config

title: Exif options

description:
Exif options
https://gohugo.io/content-management/image-processing/#image-processing-config

description:
The regexp matching the included fields
https://gohugo.io/content-management/image-processing/#image-processing-config

description:
The regexp matching the excluded fields
https://gohugo.io/content-management/image-processing/#image-processing-config

description:
Enable/disable extracting the 'photo taken' date/time into .Date
https://gohugo.io/content-management/image-processing/#image-processing-config

description:
Enable/disable extracting the 'photo taken where' into .Long and .Lat
https://gohugo.io/content-management/image-processing/#image-processing-config

description:
The language tag as defined by RFC 5646
https://gohugo.io/getting-started/configuration/#languagecode

title: language options

description:
The language options
https://gohugo.io/content-management/multilingual/#configure-languages

description: Tha language options

description:
The disabled languages
https://gohugo.io/content-management/multilingual/#disable-a-language

title: markdown options

description:
The markdown options
https://gohugo.io/getting-started/configuration-markup

title: AsciidocExt options

description:
AsciidocExt options
https://docs.asciidoctor.org/asciidoctor/latest/cli/man1/asciidoctor/#processing-information

title: document attributes

description:
The document attributes
https://docs.asciidoctor.org/asciidoctor/latest/cli/man1/asciidoctor/#document-settings

description:
The backend output file format
https://docs.asciidoctor.org/asciidoctor/latest/cli/man1/asciidoctor/#document-settings

description:
The minimum logging level
https://docs.asciidoctor.org/asciidoctor/latest/cli/man1/asciidoctor/#processing-information

description:
The safe mode
https://docs.asciidoctor.org/asciidoctor/latest/safe-modes/

description:
Enable/disable section title's auto-numbering
https://docs.asciidoctor.org/asciidoctor.js/latest/cli/options/#document-conversion

description:
Include/exclude the backtrace information on errors
https://gohugo.io/getting-started/configuration-markup#configure-markup

description:
Enable/disable verbose error printing
https://gohugo.io/getting-started/configuration-markup#configure-markup

title: Blackfriday options

description:
Blackfriday options
https://gohugo.io/getting-started/configuration-markup#blackfriday

description:
The default markdown renderer
https://gohugo.io/getting-started/configuration-markup#blackfriday

title: Goldmark options

description:
Goldmark options
https://gohugo.io/getting-started/configuration-markup#goldmark

title: extension options

description:
The extension options
https://gohugo.io/getting-started/configuration-markup#goldmark

title: parser options

description:
The parser options
https://gohugo.io/getting-started/configuration-markup#goldmark

title: renderer options

description:
The renderer options
https://gohugo.io/getting-started/configuration-markup#goldmark

title: highlighting options

description:
The highlighting options
https://gohugo.io/getting-started/configuration-markup#highlight

description:
Enable/disable anchors on line numbers
https://gohugo.io/getting-started/configuration-markup#highlight

description:
The highlighted line number range
https://gohugo.io/getting-started/configuration-markup#highlight

description:
The prefix for the anchors on line numbers
https://gohugo.io/getting-started/configuration-markup#highlight

description:
The first line
https://gohugo.io/getting-started/configuration-markup#highlight

description:
Enable/disable line numbers
https://gohugo.io/getting-started/configuration-markup#highlight

enum: algol algol_nu api arduino autumn borland bw colorful dracula emacs friendly fruity github igor lovelace manni monokai monokailight murphy native pastie perldoc pygments rainbow_dash rrt swapoff tango trac vim vs xcode

title: table of contents options

description:
The table of contents options
https://gohugo.io/getting-started/configuration-markup#table-of-contents

description:
The start heading level
https://gohugo.io/getting-started/configuration-markup#table-of-contents

description:
The end heading level
https://gohugo.io/getting-started/configuration-markup#table-of-contents

description:
Enable/disable ordered list generation
https://gohugo.io/getting-started/configuration-markup#table-of-contents

title: media type's options

description:
The media type's options
https://gohugo.io/templates/output-formats/#media-types

title: media menu options

description:
The menu options
https://gohugo.io/content-management/menus/#add-non-content-entries-to-a-menu

description:
The menu
https://gohugo.io/content-management/menus/#add-non-content-entries-to-a-menu

description:
Required when two or more menu entries have the same name
https://gohugo.io/content-management/menus/#properties-front-matter

description:
The text to display when rendering the menu entry.
https://gohugo.io/content-management/menus/#properties-front-matter

description:
Required for child entries in a nested menu.
https://gohugo.io/content-management/menus/#properties-front-matter

description:
A non-zero integer indicating the entry's position relative the root of the menu, or to its parent for a child entry
https://gohugo.io/content-management/menus/#properties-front-matter

description:
Required for internal links.
https://gohugo.io/content-management/menus/#properties-site-configuration

description:
Required for external links.
https://gohugo.io/content-management/menus/#properties-site-configuration

description:
The module options
https://gohugo.io/hugo-modules/configuration/

description:
The glob pattern matching the paths to skip when vendoring
https://gohugo.io/hugo-modules/configuration/#module-config-top-level

description:
Enable/disable picking the vendored module closest to the module using it
https://gohugo.io/hugo-modules/configuration/#module-config-top-level

description:
The proxy server to download the remote modules
https://gohugo.io/hugo-modules/configuration/#module-config-top-level

description:
The glob list of the matching paths that should not use the proxy configured above
https://gohugo.io/hugo-modules/configuration/#module-config-top-level

description:
The glob list of the matching paths that should be treated as private
https://gohugo.io/hugo-modules/configuration/#module-config-top-level

description:
The list of the module path to directory replacement mapping
https://gohugo.io/hugo-modules/configuration/#module-config-top-level

examples: path/to/input_directory1 -> path/to/output_directory1,path/to/input_directory2 -> path/to/output_directory2

title: version

description:
The version
https://gohugo.io/hugo-modules/configuration/#module-config-hugoversion

description:
The minimum required version
https://gohugo.io/hugo-modules/configuration/#module-config-hugoversion

description:
The maximum required version
https://gohugo.io/hugo-modules/configuration/#module-config-hugoversion

description:
Enable/disable requiring the extended version
https://gohugo.io/hugo-modules/configuration/#module-config-hugoversion

title: import options

description:
The import options
https://gohugo.io/hugo-modules/configuration/#module-config-imports

description:
The path
https://gohugo.io/hugo-modules/configuration/#module-config-imports

description:
Use/ignore the configuration file
https://gohugo.io/hugo-modules/configuration/#module-config-imports

description:
Use/ignore the imports
https://gohugo.io/hugo-modules/configuration/#module-config-imports

description:
Enable/disable the module
https://gohugo.io/hugo-modules/configuration/#module-config-imports

description:
Enable/disable the folder mounting
https://gohugo.io/hugo-modules/configuration/#module-config-imports

description:
Enable/disable vendoring this import
https://gohugo.io/hugo-modules/configuration/#module-config-imports

title: mount options

description:
The mount options
https://gohugo.io/hugo-modules/configuration/#module-config-mounts

description:
The source path
https://gohugo.io/hugo-modules/configuration/#module-config-mounts

description:
The target path
https://gohugo.io/hugo-modules/configuration/#module-config-mounts

description:
The language code
https://gohugo.io/hugo-modules/configuration/#module-config-mounts

description:
The included files
https://gohugo.io/hugo-modules/configuration/#module-config-mounts

description:
The excluded files
https://gohugo.io/hugo-modules/configuration/#module-config-mounts

description:
The content editor
https://gohugo.io/getting-started/configuration/#newcontenteditor

description:
Enable/disable syncing permission mode of files
https://gohugo.io/getting-started/configuration/#nochmod

description:
Enable/disable syncing modification time of files
https://gohugo.io/getting-started/configuration/#notimes

title: output format options

description:
The default number of elements per page in pagination
https://gohugo.io/getting-started/configuration/#paginate

description:
The path element used during pagination
https://gohugo.io/getting-started/configuration/#paginatepath

title: permalink options

description:
The permalink options
https://gohugo.io/content-management/urls/#permalinks

description: The permalink

examples: :year :month :monthname :day :weekday :weekdayname :yearday :section :sections :title :slug :filename

description:
Pluralize/leave titles in lists
https://gohugo.io/getting-started/configuration/#pluralizelisttitles

description:
The directory where Hugo writes the final static site
https://gohugo.io/getting-started/configuration/#publishdir

title: related content options

description:
The related content options
https://gohugo.io/getting-started/configuration/#related

description:
Include/exclude the pages newer than the current page
https://gohugo.io/content-management/related/#top-level-config-options

description:
Enable/disable lowering the case keywords in both the indexes and the queries
https://gohugo.io/content-management/related/#top-level-config-options

title: related content option's entry

description:
The related content option's entry
https://gohugo.io/content-management/related/#config-options-per-index

description:
The index name
https://gohugo.io/content-management/related/#config-options-per-index

description:
The weight indicating how important this parameter is relative to the other parameters
https://gohugo.io/content-management/related/#config-options-per-index

description:
The date format
https://gohugo.io/content-management/related/#config-options-per-index

description:
Enable/disable lowering the case keywords in both the indexes and the queries
https://gohugo.io/content-management/related/#config-options-per-index

description:
Enable/disable making all relative URLs relative to content root
https://gohugo.io/getting-started/configuration/#relativeurls

description:
The logging level for page links cannot be resolved
https://gohugo.io/getting-started/configuration/#reflinkserrorlevel

description:
The placeholder when a page reference cannot be found in `ref` or `relref`
https://gohugo.io/getting-started/configuration/#reflinksnotfoundurl

description:
Remove/leave non-spacing marks from composite characters in content paths
https://gohugo.io/getting-started/configuration/#removepathaccents

title: security options

description:
The security options
https://gohugo.io/about/security-model/#security-policy

allow: ^dart-sass-embedded$ ^go$ ^npx$ ^postcss$

default: ^dart-sass-embedded$ ^go$ ^npx$ ^postcss$

title: sitemap options

description:
The sitemap options
https://gohugo.io/templates/sitemap-template/#configure-sitemapxml

description:
The length of text in words to show in a .Summary
https://gohugo.io/getting-started/configuration/#summarylength

title: taxonomy options

description:
The taxonomy options
https://gohugo.io/content-management/taxonomies#configure-taxonomies

description:
The default taxonomy
https://gohugo.io/content-management/taxonomies#configure-taxonomies

description:
The custom taxonomy
https://gohugo.io/content-management/taxonomies#configure-taxonomies

description:
The directory where themes are stored
https://gohugo.io/getting-started/configuration/#themesdir

description:
The timeout for generating page contents
https://gohugo.io/getting-started/configuration/#timeout

description:
The time zone
https://gohugo.io/getting-started/configuration/#timezone

enum: Africa/Abidjan Africa/Accra Africa/Addis_Ababa Africa/Algiers Africa/Asmara Africa/Asmera Africa/Bamako Africa/Bangui Africa/Banjul Africa/Bissau Africa/Blantyre Africa/Brazzaville Africa/Bujumbura Africa/Cairo Africa/Casablanca Africa/Ceuta Africa/Conakry Africa/Dakar Africa/Dar_es_Salaam Africa/Djibouti Africa/Douala Africa/El_Aaiun Africa/Freetown Africa/Gaborone Africa/Harare Africa/Johannesburg Africa/Juba Africa/Kampala Africa/Khartoum Africa/Kigali Africa/Kinshasa Africa/Lagos Africa/Libreville Africa/Lome Africa/Luanda Africa/Lubumbashi Africa/Lusaka Africa/Malabo Africa/Maputo Africa/Maseru Africa/Mbabane Africa/Mogadishu Africa/Monrovia Africa/Nairobi Africa/Ndjamena Africa/Niamey Africa/Nouakchott Africa/Ouagadougou Africa/Porto-Novo Africa/Sao_Tome Africa/Timbuktu Africa/Tripoli Africa/Tunis Africa/Windhoek America/Adak America/Anchorage America/Anguilla America/Antigua America/Araguaina America/Argentina/Buenos_Aires America/Argentina/Catamarca America/Argentina/ComodRivadavia America/Argentina/Cordoba America/Argentina/Jujuy America/Argentina/La_Rioja America/Argentina/Mendoza America/Argentina/Rio_Gallegos America/Argentina/Salta America/Argentina/San_Juan America/Argentina/San_Luis America/Argentina/Tucuman America/Argentina/Ushuaia America/Aruba America/Asuncion America/Atikokan America/Atka America/Bahia America/Bahia_Banderas America/Barbados America/Belem America/Belize America/Blanc-Sablon America/Boa_Vista America/Bogota America/Boise America/Buenos_Aires America/Cambridge_Bay America/Campo_Grande America/Cancun America/Caracas America/Catamarca America/Cayenne America/Cayman America/Chicago America/Chihuahua America/Coral_Harbour America/Cordoba America/Costa_Rica America/Creston America/Cuiaba America/Curacao America/Danmarkshavn America/Dawson America/Dawson_Creek America/Denver America/Detroit America/Dominica America/Edmonton America/Eirunepe America/El_Salvador America/Ensenada America/Fort_Nelson America/Fort_Wayne America/Fortaleza America/Glace_Bay America/Godthab America/Goose_Bay America/Grand_Turk America/Grenada America/Guadeloupe America/Guatemala America/Guayaquil America/Guyana America/Halifax America/Havana America/Hermosillo America/Indiana/Indianapolis America/Indiana/Knox America/Indiana/Marengo America/Indiana/Petersburg America/Indiana/Tell_City America/Indiana/Vevay America/Indiana/Vincennes America/Indiana/Winamac America/Indianapolis America/Inuvik America/Iqaluit America/Jamaica America/Jujuy America/Juneau America/Kentucky/Louisville America/Kentucky/Monticello America/Knox_IN America/Kralendijk America/La_Paz America/Lima America/Los_Angeles America/Louisville America/Lower_Princes America/Maceio America/Managua America/Manaus America/Marigot America/Martinique America/Matamoros America/Mazatlan America/Mendoza America/Menominee America/Merida America/Metlakatla America/Mexico_City America/Miquelon America/Moncton America/Monterrey America/Montevideo America/Montreal America/Montserrat America/Nassau America/New_York America/Nipigon America/Nome America/Noronha America/North_Dakota/Beulah America/North_Dakota/Center America/North_Dakota/New_Salem America/Nuuk America/Ojinaga America/Panama America/Pangnirtung America/Paramaribo America/Phoenix America/Port-au-Prince America/Port_of_Spain America/Porto_Acre America/Porto_Velho America/Puerto_Rico America/Punta_Arenas America/Rainy_River America/Rankin_Inlet America/Recife America/Regina America/Resolute America/Rio_Branco America/Rosario America/Santa_Isabel America/Santarem America/Santiago America/Santo_Domingo America/Sao_Paulo America/Scoresbysund America/Shiprock America/Sitka America/St_Barthelemy America/St_Johns America/St_Kitts America/St_Lucia America/St_Thomas America/St_Vincent America/Swift_Current America/Tegucigalpa America/Thule America/Thunder_Bay America/Tijuana America/Toronto America/Tortola America/Vancouver America/Virgin America/Whitehorse America/Winnipeg America/Yakutat America/Yellowknife Antarctica/Casey Antarctica/Davis Antarctica/DumontDUrville Antarctica/Macquarie Antarctica/Mawson Antarctica/McMurdo Antarctica/Palmer Antarctica/Rothera Antarctica/South_Pole Antarctica/Syowa Antarctica/Troll Antarctica/Vostok Arctic/Longyearbyen Asia/Aden Asia/Almaty Asia/Amman Asia/Anadyr Asia/Aqtau Asia/Aqtobe Asia/Ashgabat Asia/Ashkhabad Asia/Atyrau Asia/Baghdad Asia/Bahrain Asia/Baku Asia/Bangkok Asia/Barnaul Asia/Beirut Asia/Bishkek Asia/Brunei Asia/Calcutta Asia/Chita Asia/Choibalsan Asia/Chongqing Asia/Chungking Asia/Colombo Asia/Dacca Asia/Damascus Asia/Dhaka Asia/Dili Asia/Dubai Asia/Dushanbe Asia/Famagusta Asia/Gaza Asia/Harbin Asia/Hebron Asia/Ho_Chi_Minh Asia/Hong_Kong Asia/Hovd Asia/Irkutsk Asia/Istanbul Asia/Jakarta Asia/Jayapura Asia/Jerusalem Asia/Kabul Asia/Kamchatka Asia/Karachi Asia/Kashgar Asia/Kathmandu Asia/Katmandu Asia/Khandyga Asia/Kolkata Asia/Krasnoyarsk Asia/Kuala_Lumpur Asia/Kuching Asia/Kuwait Asia/Macao Asia/Macau Asia/Magadan Asia/Makassar Asia/Manila Asia/Muscat Asia/Nicosia Asia/Novokuznetsk Asia/Novosibirsk Asia/Omsk Asia/Oral Asia/Phnom_Penh Asia/Pontianak Asia/Pyongyang Asia/Qatar Asia/Qostanay Asia/Qyzylorda Asia/Rangoon Asia/Riyadh Asia/Saigon Asia/Sakhalin Asia/Samarkand Asia/Seoul Asia/Shanghai Asia/Singapore Asia/Srednekolymsk Asia/Taipei Asia/Tashkent Asia/Tbilisi Asia/Tehran Asia/Tel_Aviv Asia/Thimbu Asia/Thimphu Asia/Tokyo Asia/Tomsk Asia/Ujung_Pandang Asia/Ulaanbaatar Asia/Ulan_Bator Asia/Urumqi Asia/Ust-Nera Asia/Vientiane Asia/Vladivostok Asia/Yakutsk Asia/Yangon Asia/Yekaterinburg Asia/Yerevan Atlantic/Azores Atlantic/Bermuda Atlantic/Canary Atlantic/Cape_Verde Atlantic/Faeroe Atlantic/Faroe Atlantic/Jan_Mayen Atlantic/Madeira Atlantic/Reykjavik Atlantic/South_Georgia Atlantic/St_Helena Atlantic/Stanley Australia/ACT Australia/Adelaide Australia/Brisbane Australia/Broken_Hill Australia/Canberra Australia/Currie Australia/Darwin Australia/Eucla Australia/Hobart Australia/LHI Australia/Lindeman Australia/Lord_Howe Australia/Melbourne Australia/North Australia/NSW Australia/Perth Australia/Queensland Australia/South Australia/Sydney Australia/Tasmania Australia/Victoria Australia/West Australia/Yancowinna Brazil/Acre Brazil/DeNoronha Brazil/East Brazil/West Canada/Atlantic Canada/Central Canada/Eastern Canada/Mountain Canada/Newfoundland Canada/Pacific Canada/Saskatchewan Canada/Yukon Chile/Continental Chile/EasterIsland Cuba Egypt Eire Etc/GMT Etc/GMT+0 Etc/GMT+1 Etc/GMT+10 Etc/GMT+11 Etc/GMT+12 Etc/GMT+2 Etc/GMT+3 Etc/GMT+4 Etc/GMT+5 Etc/GMT+6 Etc/GMT+7 Etc/GMT+8 Etc/GMT+9 Etc/GMT-0 Etc/GMT-1 Etc/GMT-10 Etc/GMT-11 Etc/GMT-12 Etc/GMT-13 Etc/GMT-14 Etc/GMT-2 Etc/GMT-3 Etc/GMT-4 Etc/GMT-5 Etc/GMT-6 Etc/GMT-7 Etc/GMT-8 Etc/GMT-9 Etc/GMT0 Etc/Greenwich Etc/UCT Etc/Universal Etc/UTC Etc/Zulu Europe/Amsterdam Europe/Andorra Europe/Astrakhan Europe/Athens Europe/Belfast Europe/Belgrade Europe/Berlin Europe/Bratislava Europe/Brussels Europe/Bucharest Europe/Budapest Europe/Busingen Europe/Chisinau Europe/Copenhagen Europe/Dublin Europe/Gibraltar Europe/Guernsey Europe/Helsinki Europe/Isle_of_Man Europe/Istanbul Europe/Jersey Europe/Kaliningrad Europe/Kiev Europe/Kirov Europe/Lisbon Europe/Ljubljana Europe/London Europe/Luxembourg Europe/Madrid Europe/Malta Europe/Mariehamn Europe/Minsk Europe/Monaco Europe/Moscow Europe/Nicosia Europe/Oslo Europe/Paris Europe/Podgorica Europe/Prague Europe/Riga Europe/Rome Europe/Samara Europe/San_Marino Europe/Sarajevo Europe/Saratov Europe/Simferopol Europe/Skopje Europe/Sofia Europe/Stockholm Europe/Tallinn Europe/Tirane Europe/Tiraspol Europe/Ulyanovsk Europe/Uzhgorod Europe/Vaduz Europe/Vatican Europe/Vienna Europe/Vilnius Europe/Volgograd Europe/Warsaw Europe/Zagreb Europe/Zaporozhye Europe/Zurich GB GB-Eire Hongkong Iceland Indian/Antananarivo Indian/Chagos Indian/Christmas Indian/Cocos Indian/Comoro Indian/Kerguelen Indian/Mahe Indian/Maldives Indian/Mauritius Indian/Mayotte Indian/Reunion Iran Israel Jamaica Japan Kwajalein Libya Mexico/BajaNorte Mexico/BajaSur Mexico/General Navajo NZ NZ-CHAT Pacific/Apia Pacific/Auckland Pacific/Bougainville Pacific/Chatham Pacific/Chuuk Pacific/Easter Pacific/Efate Pacific/Enderbury Pacific/Fakaofo Pacific/Fiji Pacific/Funafuti Pacific/Galapagos Pacific/Gambier Pacific/Guadalcanal Pacific/Guam Pacific/Honolulu Pacific/Johnston Pacific/Kanton Pacific/Kiritimati Pacific/Kosrae Pacific/Kwajalein Pacific/Majuro Pacific/Marquesas Pacific/Midway Pacific/Nauru Pacific/Niue Pacific/Norfolk Pacific/Noumea Pacific/Pago_Pago Pacific/Palau Pacific/Pitcairn Pacific/Pohnpei Pacific/Ponape Pacific/Port_Moresby Pacific/Rarotonga Pacific/Saipan Pacific/Samoa Pacific/Tahiti Pacific/Tarawa Pacific/Tongatapu Pacific/Truk Pacific/Wake Pacific/Wallis Pacific/Yap Poland Portugal PRC ROC Singapore US/Alaska US/Aleutian US/Arizona US/Central US/East-Indiana US/Eastern US/Hawaii US/Indiana-Starke US/Michigan US/Mountain US/Pacific US/Samoa

description:
The site title
https://gohugo.io/getting-started/configuration/#title

description:
The title case style
https://gohugo.io/getting-started/configuration/#titlecasestyle

description:
Enable/disable adding file extensions to urls
https://gohugo.io/getting-started/configuration/#uglyurls

description:
Enable/disable watching filesystem for changes and recreating as needed
https://gohugo.io/getting-started/configuration/#watch

title: Hugo static site generator config file schema


title: ui5.yaml

description: Schema for UI5 Tooling Configuration File (ui5.yaml)

$comment: See https://sap.github.io/ui5-tooling/

errorMessage:
Unsupported "specVersion"
Your UI5 CLI installation might be outdated.
Supported specification versions: "3.1", "3.0", "2.6", "2.5", "2.4", "2.3", "2.2", "2.1", "2.0", "1.1", "1.0", "0.1"
For details, see: https://sap.github.io/ui5-tooling/pages/Configuration/#specification-versions

required: specVersion type

enum: application library theme-library module

const: application

required: specVersion type metadata

$ref: #/then/then/definitions/framework

$ref: #/then/then/definitions/server

$ref: #/then/then/definitions/metadata

enum: time hash

$ref: #/then/then/definitions/builder-bundles

$ref: #/then/then/definitions/customTasks

const: library

title: Project Name

description: Unique identifier for the project, for example: organization.product.project

errorMessage: Not a valid project name. It must consist of lowercase alphanumeric characters, dash, underscore, and period only. Additionally, it may contain an npm-style package scope. For details, see: https://sap.github.io/ui5-tooling/stable/pages/Configuration/#name

title: Encoding of *.properties files

description: By default, the UI5 Tooling expects *.properties files to be UTF-8 encoded.

title: Version

description: Framework version to use in this project

errorMessage: Not a valid version according to the Semantic Versioning specification (https://semver.org/)

errorMessage: Either "development" or "optional" can be true, but not both

required: specVersion kind type metadata middleware

title: Extension Name

description: Unique identifier for the extension, for example: ui5-task-fearless-rock

errorMessage: Not a valid extension name. It must consist of lowercase alphanumeric characters, dash, underscore, and period only. Additionally, it may contain an npm-style package scope. For details, see: https://sap.github.io/ui5-tooling/stable/pages/Configuration/#name


title: Configuring plugins

description: Enables plugins for JSDoc

examples: plugins/markdown plugins/summarize

title: Specifying recursion depth

$comment: Is used only if `jsdoc` command is invoked with `-r` flag

description: Controls recursion depth for source files and tutorials

title: Specifying input files

description: Determines the set of input files

title: Input files paths

description: An array of paths to input files

$comment: `-r` flag for `jsdoc` command will recurse in subdirectories of paths listed

title: Input files exclusion paths

description: An array of paths to exclude from input

$comment: With JSDoc ^3.3.0 may include subdirectories of include

title: Inclusion RegExp

$comment: By default, .js, .jsx, .jsdoc files are included

description: Forces input filenames to match regular expression

title: Exclusion RegExp

$comment: By default, underscored files and folders are excluded

enum: module script

default: module

title: Specifying source type

description: Determines how input files are parsed

$comment: The command line options take precedence over config file

title: Incorporating CLI options

description: Determines flags that `jsdoc` command will be invoked with

$comment: Equivalent to `-a` flag

default: all

description: Only display symbols with the given `access` property

enum: all private protected public undefined

title: Symbol access

$comment: Equivalent to `--debug` flag

description: Log information that can help debug issues in JSDoc itself

title: Log debug info

$comment: Equivalent to `-d` flag

description: The path to the output folder for the generated documentation

title: Output folder

$comment: Equivalent to `-e` flag

description: Assume this encoding when reading all source files

title: Input files encoding

$comment: Equivalent to `-p` flag

description: The `package.json` file that contains the project name, version, and other details

title: Package

description: Treat errors as fatal errors, and treat warnings as errors

title: Pedantic

$comment: Equivalent to `-R` flag

description: The README.md file to include in the generated documentation

title: README.md

$comment: Equivalent to `-r` flag

description: Recurses to subdirectories when searching input files

title: Recurse to subdirectories

$comment: Equivalent to `-t` flag

default: templates/default

description: The path to the template to use for generating output

title: Output template

$comment: Equivalent to `-T` flag. Won't work if installed via NPM

description: Run JSDoc's test suite, and print the results to the console

title: Run tests

$comment: Equivalent to `-u` flag

description: Directory in which JSDoc should search for tutorials

title: Tutorials path

description: Controls allowed JSDoc tags and their interpretation

$comment: If set to `false`, emits a warning. If set to an array, whitelists tags

description: Determines how to handle unrecognized tags

title: JSDoc tag

title: Unknown tags

type: boolean array

description: Controls which tags JSDoc recognizes and how they are interpreted

$comment: ^3.3.0 two dictionaries: JSDoc and Closure Compiler

default: jsdoc closure

enum: jsdoc closure

title: Dictionary

title: JSDoc dictionaries

title: Configuring tags and tag dictionaries

description: Affects the appearance and content of generated documentation

$comment: If `true`, text of @link tag that is a URL will be rendered in normal font, else in monospace

description: Controls @link tag text rendering

title: @link URL

$comment: ^3.3.0 can be set to `false` to omit current date

description: Controls if current date is displayed in the footer of documentation

title: Showing the current date

$comment: ^3.4.0 can be set to custom layout file

description: Path to layout file to use for documentation template

title: Overriding layout file

$comment: ^3.3.0 can be set to `false` to remove links to source files

description: Disables pretty-printed source files

title: Generating pretty-printed source files

description: An array of paths that should not be copied to the output directory

description: A regular expression indicating which files to skip

description: An array of paths whose contents should be copied to the output directory

description: A regular expression indicating which files to copy

title: Copying static files

$comment: ^3.4.0 can be set to `true` to use longhands

description: Controls if shortened or longhand version of a symbol will be shown in documentation

title: Showing longnames

$comment: If `true`, all link text of inline @link tag will be rendered in monospace font

description: Controls @link tag text rendering

title: @link text

title: Configuring templates

title: JSON Schema for JSDoc configuration files


title: Cloudtoid GatewayCore Options

description: Root Schema of options for Cloudtoid GatewayCore

description: This section that contains all system wide configurations.

description: The maximum number of mappings between "inbound downstream request path" and "outbound upstream request URL" that can be cached in memory.

description: This is the section in which proxy routes are defined.

description: This is the url path pattern that if matched, the request is proxied to the address defined by its `to` property.

description: The proxy configuration.

description: This is an expression that defines the URL of the upstream server to which the downstream request is forwarded to.

description: This is an expression that defines the name of this proxy. This value is used in the Via HTTP header send on the outbound upstream request, and the outbound downstream response. If a value is specified, an `x-gwcore-proxy-name` header with this value is also added to the outbound upstream request.

default: gwcore

description: The options that control the upstream requests.

description: An expression that defines the HTTP protocol version of outbound upstream requests.

description: The options that control the upstream request headers.

description: Specifies if downstream inbound request and content headers should be discarded and not forwarded to the upstream.

description: Specifies if inbound headers with empty value should be discarded.

description: Specifies if inbound headers with an underscore in their name should be discarded.

description: Specifies if a `x-gwcore-external-address` header with the IP address of the immediate caller should be added to the outbound upstream request.

description: Specifies if the `via` header should be skipped from the outbound request.

description: Specifies if `forwarded` header and `x-forwarded-*` headers should be skipped from the outbound requests.

description: The headers to be appended to the outbound upstream requests. If the header already exists, it is kept and the new value is appended. The value can be either text or an expression.

description: The headers to be added to the outbound upstream requests. If the header already exists, its value is replaced. The value can be either text or an expression.

description: Specifies the inbound downstream headers that should be discarded.

description: The options that control connection to the upstream server.

description: The name of the .NET HttpClient that will be used to send the request. The default value is a system generated unique name.

type: string integer

description: The total timeout in milliseconds to wait for the outbound upstream request to complete. This can be a number or an expression.

description: The connect timeout in milliseconds. No timeout is set by default.

description: The expect 100 continue timeout in milliseconds.

description: Specifies how long a connection can be idle in the pool to be considered reusable.

description: Specifies how long a connection can live in the connection pool. By default, no timeout is set and the connection can stay in the pool.

description: Specifies the response drain timeout.

description: The maximum number of allowed HTTP redirects.

description: The maximum number of simultaneous TCP connections allowed to a single server. No caps are set by default.

description: The maximum size of data that can be drained from responses in bytes.

description: The maximum length, in kilobytes (1024 bytes), of the response headers.

description: Indicates whether the HTTP handler used by the outbound upstream request sender should follow redirection responses.

description: Indicates whether the HTTP handler used by the outbound upstream request sender should store server cookies and use these cookies when sending requests.

description: The options that control the downstream responses sent to the clients.

description: The options that control the downstream response headers sent to the clients.

description: Specifies if upstream inbound response, content, and trailing headers should be discarded and not forwarded to the downstream client.

description: Specifies if a `server` header should be added. The value of this header is set to `gwcore`.

description: Specifies if the `via` header should be added to the outbound response.

description: The options that are applied to the `set-cookie` headers in the inbound upstream response. If the cookie name is symbol '*', then the settings are applied to all `set-cookie` headers.

description: It limits the scope of the cookie to 'secure' channels. A secure cookie is only sent to the server when a request is made using HTTPS.

description: It limits the scope of the cookie to HTTP requests, forbidding JavaScript from accessing the cookie.

description: It asserts that a cookie must not be sent with cross-origin requests, providing some protection against cross-site request forgery attacks. The valid values are `strict`, `lax`, and `none`.

enum: none lax strict

default: lax

description: It specifies the hosts to which the cookie will be sent and can be an expression. For example, if the value of the Domain attribute is 'example.com', the user agent will include the cookie in the Cookie header when making HTTP requests to example.com, www.example.com, and www.corp.example.com. Use this property to specify or override the domain attribute. Set this value to an empty string ("") to remove the domain attribute from the cookie.

description: The headers to be appended to the outbound downstream response. If the header already exists, it is kept and the new value is appended. The value can be either text or an expression.

description: The headers to be added to the outbound downstream response. If the header already exists, its value is replaced. The value can be either text or an expression.

description: The inbound upstream headers that should be discarded.

description: The name of the header to be discarded.