Formatting tips - First Draft

This commit is contained in:
waldo1001 2021-11-11 14:34:35 +01:00
parent a84fbbda82
commit 41f1c7ccea
2 changed files with 60 additions and 0 deletions

View file

@ -0,0 +1,57 @@
+++
chapter = true
pre = "<b><i class='fas fa-clone'></i> </b>"
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" >}}`

View file

@ -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/).