Formatting tips

Tips and tricks in terms of working with MarkDown and Hugo

Markdown Cheat Sheet

Here you can find a rather interesting Cheat Sheet regarding markdown: 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:

  procedure ALGuidelinesRock()
  var
    Customer: Record Customer;
  begin
    Customer.Get('10000');
    Customer.Name := 'waldo';
    Customer.Modify(true);
  end;

Diagrams with Mermaid

When providing a documentation, diagrams come in handy. Mermaid lets you create diagrams and visualizations using text and code.

For example the following markdown section:

```mermaid
classDiagram
  Animal <|-- Duck
  Animal <|-- Fish
  Animal <|-- Zebra
  Animal : +int age
  Animal : +String gender
  Animal: +isMammal()
  Animal: +mate()
  class Duck{
    +String beakColor
    +swim()
    +quack()
  }
  class Fish{
    -int sizeInFeet
    -canEat()
  }
  class Zebra{
    +bool is_wild
    +run()
  }
```

Results in:

classDiagram
  Animal <|-- Duck
  Animal <|-- Fish
  Animal <|-- Zebra
  Animal : +int age
  Animal : +String gender
  Animal: +isMammal()
  Animal: +mate()
  class Duck{
    +String beakColor
    +swim()
    +quack()
  }
  class Fish{
    -int sizeInFeet
    -canEat()
  }
  class Zebra{
    +bool is_wild
    +run()
  }

Can’t wait to get started? Use the Mermaid Live Editor.

Hugo Shortcodes

Since we’re using “Hugo”, we can use it’s shortcode. Here is a reference: 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" >}}

makes:

"Code is Poetry!"#msdyn365bc

— waldo (@waldo1001) November 11, 2021

YouTube

{{< youtube QVOMCYitLEc >}}

makes:

Figure

{{< figure src="http://www.waldo.be/wp-content/uploads/2021/11/business-central-logo.png" title="Business Central" >}}

makes: