<?xml version="1.0" encoding="utf-8" standalone="yes"?><rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom"><channel><title>Shortcodes on PLC docs theme</title><link>https://plc-docs-theme.netlify.app/post/shortcodes/</link><description>Recent content in Shortcodes on PLC docs theme</description><generator>Hugo -- gohugo.io</generator><language>en</language><copyright>Copyright © 2021 John Doe; all Rights Reserved</copyright><atom:link href="https://plc-docs-theme.netlify.app/post/shortcodes/index.xml" rel="self" type="application/rss+xml"/><item><title>changelog</title><link>https://plc-docs-theme.netlify.app/post/shortcodes/changelog/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://plc-docs-theme.netlify.app/post/shortcodes/changelog/</guid><description>The changelog shortcode can be used for adding a changelog section to a page. It renders the data from the _changelog.yaml file which has to be stored in the same folder.
syntax:
{{&amp;lt; changelog &amp;gt;}} Example:
Content of _changelog.yaml:
- version: 0.2.0 date: 2021-01-17 author: mrBrutus changed: - &amp;quot;`group` renamed to `vars`&amp;quot; - version: 0.1.0 date: 2020-12-23 author: mrBrutus added: - initial release renders as:
Version history 0.2.0 17 Jan 2021 &amp;nbsp mrBrutus Changes Changed: group renamed to vars show full history 0.</description></item><item><title>internal</title><link>https://plc-docs-theme.netlify.app/post/shortcodes/internal/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://plc-docs-theme.netlify.app/post/shortcodes/internal/</guid><description>The internal shortcode can be used for adding internal information. This content is only rendered in development mode (environment=development).
syntax:
{{&amp;lt; internal &amp;lt;placeholder&amp;gt;&amp;gt;}} some markdown content... {{&amp;lt; /internal &amp;gt;}} The placeholder parameter is optional. It is used for specifying a placeholder image which will be shown when not in development mode (environment=production).
Example:
{{&amp;lt; internal &amp;quot;shortcode-internal.jpg&amp;quot; &amp;gt;}} ### Internal information sample - item 1 - item 2 {{&amp;lt; /internal &amp;gt;}} renders as:</description></item><item><title>lead</title><link>https://plc-docs-theme.netlify.app/post/shortcodes/lead/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://plc-docs-theme.netlify.app/post/shortcodes/lead/</guid><description>The lead shortcode can be used for adding a lead paragraph. This paragraph stands out as it has slightly larger font than the other paragraphs.
The content is taken from the inner text or, if not inner text given, from the front-matter&amp;rsquo;s description.
syntax for inner text:
{{&amp;lt; lead &amp;gt;}} My lead paragraph text... {{&amp;lt; /lead &amp;gt;}} syntax for front-matter description (using the self-closing syntax):
{{&amp;lt; lead /&amp;gt;}} Don&amp;rsquo;t forget the / for the self-closing syntax.</description></item><item><title>link</title><link>https://plc-docs-theme.netlify.app/post/shortcodes/link/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://plc-docs-theme.netlify.app/post/shortcodes/link/</guid><description>The link shortcode can be used for creating a link to another page in the same section. If the page cannot be found is will display it as text instead of hyperlink.
For library items such as functions and data types the resulting hyperlink is rendered as code (mono space font).
syntax:
{{&amp;lt; link &amp;lt;title of the page&amp;gt; &amp;lt;link text&amp;gt; &amp;gt;}} The title of the page is case sensitive.</description></item><item><title>note</title><link>https://plc-docs-theme.netlify.app/post/shortcodes/note/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://plc-docs-theme.netlify.app/post/shortcodes/note/</guid><description>The note shortcode is used for inserting a (markdown) text section which visually stands off to the rest of the document. A use case is to warn or inform the reader on something.
syntax:
{{&amp;lt; note &amp;lt;type&amp;gt; &amp;gt;}} some markdown content... {{&amp;lt; /note &amp;gt;}} The type parameter is optional. Supported types: info , warning , success , error , do , dont , learn , tip , pro , contra , download , dev Examples without type This is a sample text for {{&amp;lt; note &amp;gt;}}.</description></item><item><title>snippet</title><link>https://plc-docs-theme.netlify.app/post/shortcodes/snippet/</link><pubDate>Mon, 01 Jan 0001 00:00:00 +0000</pubDate><guid>https://plc-docs-theme.netlify.app/post/shortcodes/snippet/</guid><description>The snippet shortcode can be used for re-using snippets or text sections &amp;ndash; Create a text section once and insert it in many pages. Organize these snippets in one or more snippet bundles.
syntax:
{{&amp;lt; snippet bundle=&amp;quot;&amp;lt;name-of-the-snippet-bundle&amp;gt;&amp;quot; file=&amp;quot;&amp;lt;relative-path-of-the-snippet-file&amp;gt;&amp;quot; &amp;gt;}} bundle must be passed the name of the snippets bundle file must be passed the file path relative to the snippets bundle: Without file extension for markdown files which shall be rendered as usual.</description></item></channel></rss>