obsidian-typings/tsdoc.json

Extended type definitions for the Obsidian API (https://obsidian.md)

{
    "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
    "extends": [
        "@microsoft/api-extractor/extends/tsdoc-base.json"
    ],
    "tagDefinitions": [
        {
            "tagName": "@remark",
            "syntaxKind": "block"
        },
        {
            "tagName": "@todo",
            "syntaxKind": "block"
        },
        {
            "tagName": "@tutorial",
            "syntaxKind": "block"
        },
        {
            "tagName": "@official",
            "syntaxKind": "block"
        },
        {
            "tagName": "@unofficial",
            "syntaxKind": "block"
        }
    ],
    "supportForTags": {
        "@remark": true,
        "@todo": true,
        "@tutorial": true,
        "@official": true,
        "@unofficial": true
    }
}