From 4942f03c4c8dcf65e4c10f49c2eb1da2662cac26 Mon Sep 17 00:00:00 2001 From: Aditya Telange <21258296+adityatelange@users.noreply.github.com> Date: Sun, 7 Feb 2021 00:05:25 +0530 Subject: [PATCH] update profile mode docs --- Features.md | 1 + Installation.md | 1 + Variables.md | 21 +++++++++++---------- 3 files changed, 13 insertions(+), 10 deletions(-) diff --git a/Features.md b/Features.md index 0093441..1815bbe 100644 --- a/Features.md +++ b/Features.md @@ -163,6 +163,7 @@ params: profileMode: enabled: true title: "" # optional default will be site title + subtitle: "This is subtitle" imageUrl: "<image link>" # optional imageTitle: "<title of image as alt>" # optional imageWidth: 120 # custom size diff --git a/Installation.md b/Installation.md index 1b2b09e..c8d71f9 100644 --- a/Installation.md +++ b/Installation.md @@ -147,6 +147,7 @@ params: profileMode: enabled: false # needs to be explicitly set title: ExampleSite + subtitle: "This is subtitle" imageUrl: "<img location>" imageWidth: 120 imageHeight: 120 diff --git a/Variables.md b/Variables.md index 98018b6..e22446e 100644 --- a/Variables.md +++ b/Variables.md @@ -46,15 +46,16 @@ #### profileMode -| name | type | example | Description | -| ----------------------- | ------- | ---------------------------------------------- | ----------- | -| profileMode.enabled | boolean | true \| false | | -| profileMode.title | string | "Title" | | -| profileMode.imageUrl | string | "image.png" \| "https://example.com/image.jpg" | | -| profileMode.imageWidth | string | "" | | -| profileMode.imageHeight | string | "" | | -| profileMode.imageTitle | string | "This image is a picture of .." | | -| profileMode.buttons | - | - | | +| name | type | example | Description | +| ----------------------- | ------- | ---------------------------------------------- | ---------------------------------------------------- | +| profileMode.enabled | boolean | true \| false | For enabling profileMode, needs to be explicitly set | +| profileMode.title | string | "Title" | Title | +| profileMode.subtitle | string | "subtitle here" | Subtitle | +| profileMode.imageUrl | string | "image.png" \| "https://example.com/image.jpg" | Image URL or Link | +| profileMode.imageWidth | string | "150" | Width of image | +| profileMode.imageHeight | string | "150" | Height of image | +| profileMode.imageTitle | string | "This image is a picture of .." | Title of image | +| profileMode.buttons | - | - | [Details](#profileMode.buttons) | #### assets @@ -97,7 +98,7 @@ socialIcons: url: "<link2>" ``` -#### +#### profileMode.buttons ```yml profileMode: