templates

Home >> Settings >> Templates

Templates

Defines settings for handling templates and examples.

{
    "deploy": {
        "templates": {
            "sources": [
                "https://example.com/vs-deploy/my-templates-from-web.json",
                "E:/vs-deploy/my-local-templates.json",
                "sftp://example.com@user:password/vs-deploy/my-templates-from-sftp-server.json",
                "./a/project/repository/inside/workspace.json",
                "ftp://example.com@user:password/vs-deploy/my-templates-from-FTP-server.json"
            ],

            "allowUnparsedDocuments": true
        }
    }
}

Name	Description
allowUnparsedDocuments	Allow unparsed (HTML) documents in internal web browser or not. Default: (false)
footer*	Path or URL to a HTML footer that should be inserted at the beginning inside the BODY tag of each (default) HTML document.
header*	Path or URL to a HTML header that should be inserted at the beginning inside the BODY tag of each (default) HTML document.
showDefaults	Show default sources or not. Default: (true)
sources	A list of one or more additional source.

^{* supports placeholders}

Sources / repositories

Have a look at the vs-deploy.json and targets.json files, to get an idea about the structure of a repository.

Categories

Defines a category that contains child elements.

{
    "Category 1": {
        "children": {
            "Category 1.1": {
                "type": "category",

                "children": {
                    "Link 1.1": {
                        "type": "link",
                        "source": "https://github.com/mkloubert/vs-deploy"
                    },

                    "File 1.1": {
                        "type": "file",
                        "source": "https://mkloubert.github.io/templates/vs-deploy/targets/ftp/azure.md"
                    }
                }
            },

            "Category 2.1": {
                "type": "category",

                "children": {
                    "Link 2.1.a": {
                        "type": "link",
                        "source": "https://mkloubert.github.io/vs-deploy"
                    },

                    "Respository 2.1.b": {
                        "type": "repository",
                        "source": "https://mkloubert.github.io/templates/vs-deploy/targets.json"
                    }
                }
            },

            "Link 1.a": {
                "type": "link",
                "source": "https://github.com/mkloubert/vs-deploy/wiki"
            }
        }
    }
}

Name	Description
children	One or more child.
icon	A custom icon (s. octicons.css). Default: file-directory
sortOrder	A value to sort that category. Default: 0
type	Possible values: category, cat, c
$requires$	An optional value that defines the minimum version of the extension, which is required to display that category. Example: 8.0.0

Files

Loads a file, like a text file, HTML or Markdown document, from a (local / network) path or URL and displays it in the editor.

{
    "File 1": {
        "type": "file",
        "source": "https://github.com/mkloubert/vs-deploy/blob/master/LICENSE",

        "description": "This file will be displayed AFTER 'File 2'",

        "sortOrder": 2000
    },

    "File 2": {
        "type": "file",
        "source": "/path/to/a/local/file.md",

        "description": "This file will be displayed BEFORE 'File 1'",

        "sortOrder": 1000
    },

    "File 3": {
        "type": "file",
        "source": "./path/to/a/file/inside/workspace.ts"
    }
}

Name	Description
description	An optional description for the file.
icon	A custom icon (s. octicons.css). Default: file-code
isDocument	Gets if the file in an (HTML) document, that should be displayed in browser directly. Default: (false)
source	The URL or path to the file.
sortOrder	A value to sort that category. Default: 0
type	Possible values: file, f
$requires$	An optional value that defines the minimum version of the extension, which is required to display that file. Example: 8.0.0

Links

Opens a file or URL.

{
    "Link 1": {
        "type": "link",
        "source": "https://twitter.com/mjkloubert",

        "description": "This link will be displayed AFTER 'Link 2'",

        "sortOrder": 2000
    },

    "Link 2": {
        "type": "link",
        "source": "/path/to/a/local/file",

        "description": "This link will be displayed BEFORE 'Link 1'",

        "sortOrder": 1000
    },

    "Link 3": {
        "type": "link",
        "source": "./path/to/a/file/inside/workspace.html"
    }
}

Name	Description
description	An optional description for the link.
icon	A custom icon (s. octicons.css). Default: link-external
source	The URL or path of the link.
sortOrder	A value to sort that category. Default: 0
type	Possible values: link, l, url, u
$requires$	An optional value that defines the minimum version of the extension, which is required to display that link. Example: 8.0.0

(External) Repositories

Loads an external repository and handles it like a category.

{
    "Repository 1": {
        "type": "repository",
        "source": "https://mkloubert.github.io/templates/vs-deploy.json",

        "description": "This repository will be displayed AFTER 'Repository 2'",

        "sortOrder": 2000
    },

    "Repository 2": {
        "type": "repository",
        "source": "/path/to/a/local/repository/file.json",

        "description": "This repository will be displayed BEFORE 'Repository 1'",

        "sortOrder": 1000
    },

    "Repository 3": {
        "type": "repository",
        "source": "./path/to/a/repository/file/inside/workspace.json"
    }
}

Name	Description
description	An optional description for the repository.
icon	A custom icon (s. octicons.css). Default: database
source	The URL or path of the link.
sortOrder	A value to sort that category. Default: 0
type	Possible values: repository, repo, r
$requires$	An optional value that defines the minimum version of the extension, which is required to display that repository. Example: 8.0.0