From 41f1c7ccea33fc462cb35de5b7ba66ea31a10f4a Mon Sep 17 00:00:00 2001 From: waldo1001 Date: Thu, 11 Nov 2021 14:34:35 +0100 Subject: [PATCH] Formatting tips - First Draft --- content/Contributing/FormattingTips/index.md | 57 ++++++++++++++++++++ content/Contributing/_index.md | 3 ++ 2 files changed, 60 insertions(+) create mode 100644 content/Contributing/FormattingTips/index.md diff --git a/content/Contributing/FormattingTips/index.md b/content/Contributing/FormattingTips/index.md new file mode 100644 index 00000000..5907d999 --- /dev/null +++ b/content/Contributing/FormattingTips/index.md @@ -0,0 +1,57 @@ ++++ +chapter = true +pre = " " +title = "Tips and tricks in terms of working with MarkDown and Hugo" +linktitle = "Formatting tips" +weight = 100 ++++ + +# + +## Markdown Cheat Sheet +Here you can find a rather interesting Cheat Sheet regarding markdown: [https://www.markdownguide.org/cheat-sheet](https://www.markdownguide.org/cheat-sheet) + +## Code Fences / Syntax highlighting + +The syntax to use codefences is with backticks. If you provide the language after the first block of backticks, github will automatically put that in decent syntax highlighting. So, A simple code fence with AL code, can simply be done by: +```` +```al + procedure ALGuidelinesRock() + var + Customer: Record Customer; + begin + Customer.Get('10000'); + Customer.Name := 'waldo'; + Customer.Modify(true); + end; +``` +```` + +Results in: +```al + procedure ALGuidelinesRock() + var + Customer: Record Customer; + begin + Customer.Get('10000'); + Customer.Name := 'waldo'; + Customer.Modify(true); + end; +``` + +## Hugo Shortcodes +Since we're using "Hugo", we can use it's shortcode. Here is a reference: [https://gohugo.io/content-management/shortcodes/](https://gohugo.io/content-management/shortcodes/) + +It basically means we are able to use easy notations to do cool things. Let's point out some useful shortcodes: + +### Twitter + +`{{< tweet user="waldo1001" id="1458787011024805892" >}}` + +### YouTube + +`{{< youtube QVOMCYitLEc >}}` + +### Figure + +`{{< figure src="/media/spf13.jpg" title="Steve Francia" >}}` diff --git a/content/Contributing/_index.md b/content/Contributing/_index.md index b97b3d33..d7b671fa 100644 --- a/content/Contributing/_index.md +++ b/content/Contributing/_index.md @@ -22,3 +22,6 @@ This project has adopted the Microsoft Open Source Code of Conduct. For more inf - For [patterns](/contributing/templates/patterns/) - For [guidelines](/contributing/templates/guidelines/) * [Understanding the Approval Process](/contributing/theapprovalprocess/) + +Here are some [tips and tricks in terms of working with MarkDown and Hugo](/contributing/formattingtips/). +