sp-dev-fx-webparts/templates/sample-template.json

[
  {
    "name": "pnp-sp-dev-spfx-web-parts-YOUR-SAMPLE-NAME",
    "source": "pnp",
    "title": "YOUR-SAMPLE-TITLE",
    "shortDescription": "YOUR-SHORT-DESCRIPTION",
    "url": "https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/YOUR-SAMPLE-NAME",
    "downloadUrl": "https://pnp.github.io/download-partial/?url=https://github.com/pnp/sp-dev-fx-webparts/tree/main/samples/YOUR-SAMPLE-NAME",
    "longDescription": [
      "YOUR-SHORT-DESCRIPTION"
    ],
    "creationDateTime": "2024-12-25",
    "updateDateTime": "2024-12-31",
    "products": [
      "SharePoint"
    ],
    "metadata": [
      {
        "key": "CLIENT-SIDE-DEV",
        "value": "React"
      },
      {
        "key": "SPFX-VERSION",
        "value": "1.18.2"
      }
    ],
    "thumbnails": [
      {
        "type": "image",
        "order": 100,
        "url": "https://github.com/pnp/sp-dev-fx-webparts/raw/main/samples/YOUR-SAMPLE-NAME/assets/YOUR-IMAGE-NAME-HERE",
        "alt": "Web Part Preview"
      },
      {
        "type": "video",
        "order": 101,
        "url": "https://www.youtube.com/embed/FS-_0KENJkI",
        "alt": "Community demo of the web part"
      }
    ],
    "authors": [
      {
        "gitHubAccount": "YOUR-GITHUB-ACCOUNT",
        "pictureUrl": "https://github.com/YOUR-GITHUB-ACCOUNT.png",
        "name": "YOUR-NAME"
      }
    ],
    "references": [
      {
        "name": "Build your first SharePoint client-side web part",
        "description": "Client-side web parts are client-side components that run in the context of a SharePoint page. Client-side web parts can be deployed to SharePoint environments that support the SharePoint Framework. You can also use modern JavaScript web frameworks, tools, and libraries to build them.",
        "url": "https://docs.microsoft.com/sharepoint/dev/spfx/web-parts/get-started/build-a-hello-world-web-part"
      }
    ]
  }
]