From b4f86aa9eb1cd42b4d78e3cccc25bd071ad10beb Mon Sep 17 00:00:00 2001
From: sebthom <sebthom@users.noreply.github.com>
Date: Wed, 22 Nov 2023 20:28:25 +0100
Subject: [PATCH] add format doc

---
 plugin/syntaxes.sources.yaml | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

diff --git a/plugin/syntaxes.sources.yaml b/plugin/syntaxes.sources.yaml
index 59eaa1f..de9864c 100644
--- a/plugin/syntaxes.sources.yaml
+++ b/plugin/syntaxes.sources.yaml
@@ -1,4 +1,20 @@
 sources:
+  # source entry format:
+  # <reo-id>:
+  #   github: # required
+  #     repo: # required
+  #     path: # optional
+  #   languages: # optional, only required if repo contains no package.json
+  #     <language-id>: # existing id as defined in package.json to override values or a new language id to add languages not defined in a package.json
+  #       ignore: <true|false>        # optional, default is false
+  #       example: <path_in_repo|url> # optional
+  #       grammar: <path_in_repo>     # required if not defined in package.json
+  #       langcfg: <path_in_repo|url> # optional
+  #       label:                      # required if not defined in package.json
+  #       scope_name:                 # required if not defined in package.json
+  #       file_extensions: []         # optional
+  #       file_patterns: []           # optional
+
   apache-http:
     github:
       repo: mrmlnc/vscode-apache