From c5340d108f388445b4aafaa0122f880b7d40770d Mon Sep 17 00:00:00 2001 From: Mircea-Pavel ANTON Date: Wed, 18 Jan 2023 09:10:53 +0000 Subject: [PATCH] Fix markdown linting issues. --- exampleSite/content/docs/shortcodes/index.md | 31 ++++++++------------ 1 file changed, 13 insertions(+), 18 deletions(-) diff --git a/exampleSite/content/docs/shortcodes/index.md b/exampleSite/content/docs/shortcodes/index.md index b3d8bb71..07a8ef3c 100644 --- a/exampleSite/content/docs/shortcodes/index.md +++ b/exampleSite/content/docs/shortcodes/index.md @@ -40,6 +40,7 @@ Don't forget to [follow me](https://twitter.com/nunocoracao) on Twitter. {{< /alert >}} ## Article + `Article` will embed a single article into a markdown file. The `link` to the file should be the `.RelPermalink` of the file to be embedded. Note that the shortcode will not display anything if it's referencing it's parent. *Note: if you are running your website in a subfolder like Blowfish (i.e. /blowfish/) please include that path in the link.* @@ -56,8 +57,6 @@ Don't forget to [follow me](https://twitter.com/nunocoracao) on Twitter. {{< article link="/docs/welcome/" >}} - - ## Badge `badge` outputs a styled badge component which is useful for displaying metadata. @@ -102,8 +101,6 @@ Call to action {{< carousel "gallery/03.jpg" "gallery/01.jpg" "gallery/02.jpg" "gallery/04.jpg" >}} - - ## Chart `chart` uses the Chart.js library to embed charts into articles using simple structured data. It supports a number of [different chart styles](https://www.chartjs.org/docs/latest/samples/) and everything can be configured from within the shortcode. Simply provide the chart parameters between the shortcode tags and Chart.js will do the rest. @@ -181,7 +178,6 @@ Blowfish also supports automatic conversion of images included using standard Ma {{< figure src="abstract.jpg" alt="Abstract purple artwork" caption="Photo by [Jr Korpa](https://unsplash.com/@jrkorpa) on [Unsplash](https://unsplash.com/)" >}} - ## Gallery `gallery` allows you to showcase multiple images at once, in a responsive manner with more varied and interesting layouts. @@ -212,7 +208,6 @@ In order to add images to the gallery, use `img` tags for each image and add `cl {{< /gallery >}} - ## GitHub Card `github` allows you to quickly link a github repository, all while showing and updating in realtime stats about it, such as the number of stars and forks it has. @@ -231,7 +226,6 @@ In order to add images to the gallery, use `img` tags for each image and add `cl {{< github repo="nunocoracao/blowfish" >}} - ## Icon `icon` outputs an SVG icon and takes the icon name as its only parameter. The icon is scaled to match the current text size. @@ -287,6 +281,7 @@ When life gives you lemons, make lemonade. {{< /lead >}} ## List + `List` will display a list of recent articles. This shortcode requires a limit value to constraint the list. Additionally, it supports a `where` and a `value` in order to filter articles by their parameters. Note that this shortcode will not display its parent page but it will count for the limit value. @@ -299,6 +294,7 @@ When life gives you lemons, make lemonade. **Example #1:** + ```md {{}} ``` @@ -306,13 +302,13 @@ When life gives you lemons, make lemonade. {{< list limit=2 >}} **Example #2:** + ```md {{}} ``` {{< list limit=2 where="Type" value="sample">}} - ## Mermaid `mermaid` allows you to draw detailed diagrams and visualisations using text. It uses Mermaid under the hood and supports a wide variety of diagrams, charts and other output formats. @@ -340,9 +336,11 @@ B-->C[Profit] You can see some additional Mermaid examples on the [diagrams and flowcharts samples]({{< ref "diagrams-flowcharts" >}}) page. ## Swatches + `swatches` outputs a set of up to three different colors to showcase color elements like a color palette. This shortcode takes the `HEX` codes of each color and creates the visual elements for each. **Example** + ```md {{}} ``` @@ -350,7 +348,6 @@ You can see some additional Mermaid examples on the [diagrams and flowcharts sam **Output** {{< swatches "#64748b" "#3b82f6" "#06b6d4" >}} - ## TypeIt [TypeIt](https://www.typeitjs.com) is the most versatile JavaScript tool for creating typewriter effects on the planet. With a straightforward configuration, it allows you to type single or multiple strings that break lines, delete & replace each other, and it even handles strings that contain complex HTML. @@ -372,8 +369,6 @@ Blowfish implements a sub-set of TypeIt features using a `shortcode`. Write your - - **Example 1:** ```md @@ -383,7 +378,7 @@ Lorem ipsum dolor sit amet ``` {{< typeit >}} -Lorem ipsum dolor sit amet +Lorem ipsum dolor sit amet {{< /typeit >}} **Example 2:** @@ -398,15 +393,14 @@ consectetur adipiscing elit. {{}} ``` -{{< typeit +{{< typeit tag=h1 lifeLike=true >}} -Lorem ipsum dolor sit amet, -consectetur adipiscing elit. +Lorem ipsum dolor sit amet, +consectetur adipiscing elit. {{< /typeit >}} - **Example 3:** ```md @@ -420,7 +414,8 @@ Lorem ipsum dolor sit amet, consectetur adipiscing elit. {{}} ``` -{{< typeit + +{{< typeit tag=h3 speed=50 breakLines=false @@ -429,4 +424,4 @@ consectetur adipiscing elit. "Frankly, my dear, I don't give a damn." Gone with the Wind (1939) "I'm gonna make him an offer he can't refuse." The Godfather (1972) "Toto, I've a feeling we're not in Kansas anymore." The Wizard of Oz (1939) -{{< /typeit >}} \ No newline at end of file +{{< /typeit >}}