From 26cf73029abc713a18ef51ec55172514e51e54dc Mon Sep 17 00:00:00 2001
From: Regis Philibert <login@regisphilibert.com>
Date: Tue, 15 Jun 2021 15:47:37 +0000
Subject: [PATCH] Refactor social service logic

---
 layouts/partials/func/socials/GetBuiltInServicesDefaults.html |   26 ++++++++++++++++++++++++++
 1 files changed, 26 insertions(+), 0 deletions(-)

diff --git a/layouts/partials/func/socials/GetServicesData.html b/layouts/partials/func/socials/GetBuiltInServicesDefaults.html
similarity index 60%
rename from layouts/partials/func/socials/GetServicesData.html
rename to layouts/partials/func/socials/GetBuiltInServicesDefaults.html
index 750c96e..69eaba2 100644
--- a/layouts/partials/func/socials/GetServicesData.html
+++ b/layouts/partials/func/socials/GetBuiltInServicesDefaults.html
@@ -1,3 +1,29 @@
+{{/*
+  GetBuiltInServicesData
+  Returns a map whose keys stores the map of defaults data for any built-in service. 
+  We use a key to easily grab the data with `index $that github`
+
+  @author @regisphilibert
+
+  @context Any (.)
+
+  @access public
+
+  @returns Map
+
+
+  ## Contributors can add a built-in service
+
+  1. Adding it to the following map with the following format:
+  ```yaml
+  # [...]
+  shinyandnew:
+    label: Shiny And New
+    color: '#cccccc'
+  ```
+  2. Edit README file with service.
+
+*/}}
 {{ return (`
   facebook:
     share: true

--
Gitblit v1.10.0