Microsoft/alguidelines
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

deploy: ed09a81f6a

Browse source
This commit is contained in:
JeremyVyska 2022-03-08 08:09:58 +00:00
parent 2f8078f0df
commit 34079491f7
203 changed files with 1121 additions and 782 deletions
Download patch file Download diff file Expand all files Collapse all files

67
docs/contributing/formattingtips/index.html
View file

@ -2,7 +2,7 @@
<head>
<meta charset=utf-8>
<meta name=viewport content="width=device-width,initial-scale=1,shrink-to-fit=no">
<meta name=generator content="Hugo 0.93.0">
<meta name=generator content="Hugo 0.93.2">
<meta name=robots content="index, follow">
<link rel="shortcut icon" href=/favicons/favicon.ico>
<link rel=apple-touch-icon href=/favicons/apple-touch-icon-180x180.png sizes=180x180>
@ -22,12 +22,12 @@ Here you can find a rather interesting Cheat Sheet regarding markdown: …">
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:">
<meta property="og:type" content="article">
<meta property="og:url" content="https://alguidelines.dev/docs/contributing/formattingtips/"><meta property="og:image" content="https://alguidelines.dev/images/og-image-fission.png"><meta property="article:section" content="docs">
<meta property="article:modified_time" content="2022-02-20T20:58:53+01:00"><meta property="og:site_name" content="alguidelines.dev - Business Central Design Patterns">
<meta property="article:modified_time" content="2022-03-06T18:22:58+01:00"><meta property="og:site_name" content="alguidelines.dev - Business Central Design Patterns">
<meta itemprop=name content="Formatting tips">
<meta itemprop=description content="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:">
<meta itemprop=dateModified content="2022-02-20T20:58:53+01:00">
<meta itemprop=wordCount content="158"><meta itemprop=image content="https://alguidelines.dev/images/og-image-fission.png">
<meta itemprop=dateModified content="2022-03-06T18:22:58+01:00">
<meta itemprop=wordCount content="282"><meta itemprop=image content="https://alguidelines.dev/images/og-image-fission.png">
<meta itemprop=keywords content><meta name=twitter:card content="summary_large_image">
<meta name=twitter:image content="https://alguidelines.dev/images/og-image-fission.png">
<meta name=twitter:title content="Formatting tips">
@ -55,7 +55,7 @@ Code Fences / Syntax highlighting The syntax to use codefences is with backticks
<a class=nav-link href=https://github.com/microsoft/alguidelines target=_blank><i class="fab fa-github"></i><span>GitHub</span></a>
</li><li class="nav-item mr-4 mb-2 mb-lg-0">
<a class=nav-link href=https://discord.gg/4wbfNv3 target=_blank><i class="fab fa-discord"></i><span>Discord</span></a>
</li></ul></div><div class="navbar-nav d-none d-lg-block"><input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.431b8260278e5337faf5b172bf8fc24c.json data-offline-search-base-href=/ data-offline-search-max-results=10>
</li></ul></div><div class="navbar-nav d-none d-lg-block"><input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.bbdc1ba5f5e27ee07e6823c62c585a62.json data-offline-search-base-href=/ data-offline-search-max-results=10>
</div></nav></header><div class="container-fluid td-outer">
<div class=td-main>
<div class="row flex-xl-nowrap">
@ -63,7 +63,7 @@ Code Fences / Syntax highlighting The syntax to use codefences is with backticks
<div id=td-sidebar-menu class=td-sidebar__inner>
<div id=content-mobile>
<form class="td-sidebar__search d-flex align-items-center">
<input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.431b8260278e5337faf5b172bf8fc24c.json data-offline-search-base-href=/ data-offline-search-max-results=10>
<input type=search class="form-control td-search-input" placeholder="&#xf002; Search this site…" aria-label="Search this site…" autocomplete=off data-offline-search-index-json-src=/offline-search-index.bbdc1ba5f5e27ee07e6823c62c585a62.json data-offline-search-base-href=/ data-offline-search-max-results=10>
<button class="btn btn-link td-sidebar__toggle d-md-none p-0 ml-3 fas fa-bars" type=button data-toggle=collapse data-target=#td-section-nav aria-controls=td-docs-nav aria-expanded=false aria-label="Toggle section navigation">
</button>
</form></div><div id=content-desktop></div><nav class="collapse td-sidebar-nav" id=td-section-nav>
@ -457,7 +457,7 @@ Code Fences / Syntax highlighting The syntax to use codefences is with backticks
<a href=https://github.com/microsoft/alguidelines/issues/new class=td-page-meta--project-issue target=_blank rel=noopener><i class="fas fa-tasks fa-fw"></i> Create project issue</a>
</div><div class=td-toc><nav id=TableOfContents>
<ul>
<li><a href=#markdown-cheat-sheet>Markdown Cheat Sheet</a></li><li><a href=#code-fences--syntax-highlighting>Code Fences / Syntax highlighting</a></li><li><a href=#hugo-shortcodes>Hugo Shortcodes</a>
<li><a href=#markdown-cheat-sheet>Markdown Cheat Sheet</a></li><li><a href=#code-fences--syntax-highlighting>Code Fences / Syntax highlighting</a></li><li><a href=#diagrams-with-mermaid>Diagrams with Mermaid</a></li><li><a href=#hugo-shortcodes>Hugo Shortcodes</a>
<ul>
<li><a href=#twitter>Twitter</a></li><li><a href=#youtube>YouTube</a></li><li><a href=#figure>Figure</a></li></ul></li></ul></nav></div><div class="taxonomy taxonomy-terms-cloud taxo-tags">
<h5 class=taxonomy-title>Tag Cloud</h5><ul class=taxonomy-terms>
@ -492,7 +492,51 @@ Code Fences / Syntax highlighting The syntax to use codefences is with backticks
</span></span></span><span style=display:flex><span><span style=color:#f8f8f8;text-decoration:underline> </span>Customer<span style=color:#ce5c00;font-weight:700>.</span>Name<span style=color:#f8f8f8;text-decoration:underline> </span><span style=color:#ce5c00;font-weight:700>:=</span><span style=color:#f8f8f8;text-decoration:underline> </span><span style=color:#4e9a06>&#39;waldo&#39;</span><span style=color:#000;font-weight:700>;</span><span style=color:#f8f8f8;text-decoration:underline>
</span></span></span><span style=display:flex><span><span style=color:#f8f8f8;text-decoration:underline> </span>Customer<span style=color:#ce5c00;font-weight:700>.</span><span style=color:#204a87;font-weight:700>Modify</span><span style=color:#ce5c00;font-weight:700>(</span>true<span style=color:#ce5c00;font-weight:700>)</span><span style=color:#000;font-weight:700>;</span><span style=color:#f8f8f8;text-decoration:underline>
</span></span></span><span style=display:flex><span><span style=color:#f8f8f8;text-decoration:underline> </span><span style=color:#204a87;font-weight:700>end</span><span style=color:#000;font-weight:700>;</span><span style=color:#f8f8f8;text-decoration:underline>
</span></span></span></code></pre></div><h2 id=hugo-shortcodes>Hugo Shortcodes</h2><p>Since we&rsquo;re using &ldquo;Hugo&rdquo;, we can use it&rsquo;s shortcode. Here is a reference: <a href=https://gohugo.io/content-management/shortcodes/>https://gohugo.io/content-management/shortcodes/</a></p><p>It basically means we are able to use easy notations to do cool things. Let&rsquo;s point out some useful shortcodes:</p><h3 id=twitter>Twitter</h3><pre tabindex=0><code>{{&lt; tweet user=&#34;waldo1001&#34; id=&#34;1458787011024805892&#34; &gt;}}
</span></span></span></code></pre></div><h2 id=diagrams-with-mermaid>Diagrams with Mermaid</h2><p>When providing a documentation, diagrams come in handy. <a href=https://mermaid-js.github.io/mermaid/#/>Mermaid</a> lets you create diagrams and visualizations using text and code.</p><p>For example the following markdown section:</p><pre tabindex=0><code>```mermaid
classDiagram
Animal &lt;|-- Duck
Animal &lt;|-- Fish
Animal &lt;|-- 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()
}
```
</code></pre><p>Results in:</p><pre tabindex=0><code class=language-mermaid data-lang=mermaid>classDiagram
Animal &lt;|-- Duck
Animal &lt;|-- Fish
Animal &lt;|-- 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()
}
</code></pre><p>Can&rsquo;t wait to get started? Use the Mermaid <a href=https://mermaid.live/edit>Live Editor</a>.</p><h2 id=hugo-shortcodes>Hugo Shortcodes</h2><p>Since we&rsquo;re using &ldquo;Hugo&rdquo;, we can use it&rsquo;s shortcode. Here is a reference: <a href=https://gohugo.io/content-management/shortcodes/>https://gohugo.io/content-management/shortcodes/</a></p><p>It basically means we are able to use easy notations to do cool things. Let&rsquo;s point out some useful shortcodes:</p><h3 id=twitter>Twitter</h3><pre tabindex=0><code>{{&lt; tweet user=&#34;waldo1001&#34; id=&#34;1458787011024805892&#34; &gt;}}
</code></pre><p>makes:
<blockquote class=twitter-tweet><p lang=en dir=ltr>"Code is Poetry!"<a href="https://twitter.com/hashtag/msdyn365bc?src=hash&ref_src=twsrc%5Etfw">#msdyn365bc</a></p>&mdash; waldo (@waldo1001) <a href="https://twitter.com/waldo1001/status/1458787011024805892?ref_src=twsrc%5Etfw">November 11, 2021</a></blockquote><script async src=https://platform.twitter.com/widgets.js></script>
</p><h3 id=youtube>YouTube</h3><pre tabindex=0><code>{{&lt; youtube QVOMCYitLEc &gt;}}
@ -504,8 +548,8 @@ Code Fences / Syntax highlighting The syntax to use codefences is with backticks
<figure>
<img src=http://www.waldo.be/wp-content/uploads/2021/11/business-central-logo.png> <figcaption>
<h4>Business Central</h4></figcaption></figure></p><div class="text-muted mt-5 pt-3 border-top">
Last modified February 20, 2022: <a href=https://github.com/microsoft/alguidelines/commit/3d0cb3a40bf1b3ca00d2c10d7a977e2a806818e3>Moving contributing (3d0cb3a4)</a>
by Jeremy Vyska
Last modified March 6, 2022: <a href=https://github.com/microsoft/alguidelines/commit/75dd79f90455e9ec564bbeff8e4f353bea685c0f>added mermaid to formatting tips (75dd79f9)</a>
by Christian Bräunlich
</div></div></main></div></div><footer class="bg-dark py-5 row d-print-none">
<div class="container-fluid mx-sm-5">
<div class=row>
@ -528,6 +572,7 @@ by Jeremy Vyska
<small class=text-white>&copy; 2022 alguidelines.dev Project All Rights Reserved</small>
</div></div></div></footer></div><script src=https://cdn.jsdelivr.net/npm/popper.js@1.16.1/dist/umd/popper.min.js integrity=sha384-9/reFTGAW83EW2RDu2S0VKaIzap3H66lZH81PoYlFhbGU+6BZp6G7niu735Sk7lN crossorigin=anonymous></script>
<script src=https://cdn.jsdelivr.net/npm/bootstrap@4.6.1/dist/js/bootstrap.min.js integrity="sha512-UR25UO94eTnCVwjbXozyeVd6ZqpaAE9naiEUBK/A+QDbfSTQFhPGj5lOR6d8tsgbBk84Ggb5A3EkjsOgPRPcKA==" crossorigin=anonymous></script>
<script src=https://cdn.jsdelivr.net/npm/mermaid@8.13.4/dist/mermaid.min.js integrity="sha512-JERecFUBbsm75UpkVheAuDOE8NdHjQBrPACfEQYPwvPG+fjgCpHAz1Jw2ci9EXmd3DdfiWth3O3CQvcfEg8gsA==" crossorigin=anonymous></script>
<script src=/js/tabpane-persist.js></script>
<script src=/js/main.min.fc1551b8c1b40a6eaa08f3cb9c76f12ccd9aebc436cecdaf2341c890206d024a.js integrity="sha256-/BVRuMG0Cm6qCPPLnHbxLM2a68Q2zs2vI0HIkCBtAko=" crossorigin=anonymous></script>
<script src=/js/main.min.1500f857e5b06ea55f06028543e63e43bdb8065e41f69096eca669969a881048.js integrity="sha256-FQD4V+WwbqVfBgKFQ+Y+Q724Bl5B9pCW7KZplpqIEEg=" crossorigin=anonymous></script>
</body></html>