Template (syntax)
ST Edge AI Core Technology 2.2.0
UNDER CONSTRUCTION!
About writing and formatting the articles
Formatting is mainly based on Markdown syntax with some minor extensions respecting the requested syntax to write the GitHub pages.
[1]
Mardown Guide - Basic Syntax
[2]
Basic writing and formatting syntax
Syntax
Headings
see section “Headings” [1] & [2]
# A first-level heading
## A second-level heading
### A third-level heading
Styling text
see section “Styling text” [1] & [2]
I just love **bold text**.
Italicized text is the *cat's meow*. This text is ***really important***.
The rendered output looks like this:
I just love bold text. Italicized text is the cat’s meow. This text is really important.
Images
see section “Images” [1]
To add an image, add an exclamation mark (!), followed by alt text in brackets, and the path or URL to the image asset in parentheses. You can optionally add a title in quotation marks after the path or URL. By default (see css file), the images are centered.
Minimal syntax
{width=40%}
Two syntax are possible to indicate the
width
attribute:{width=40%}
or{style="width: 40%;"}
.The rendered output looks like this:
Syntax with figcaption and title
{style="width: 70%;"}
The rendered output looks like this:
Links
This site was built using GitHub Pages.
Alert/Admonitions messages
The > [!TYPE]
Github syntax and
!!! TYPE
Material for MkDocs syntax are supported.
Note
Highlights information that users should take into account, even when skimming.
Tip
Optional information to help a user be more successful.
Important
Crucial information necessary for users to succeed.
Warning
Critical content demanding immediate user attention due to potential risks.
Caution
Negative potential consequences of an action.
Important
Crucial information necessary for users to succeed.
Note
With list + code
- test1
- sub-item
- test 2
Test suite
def helloworld(str):
"""."""
print(str)
Footnote
@octocat :+1: This PR looks great - it’s ready to merge! :shipit:
Here is a simple footnote1.
A footnote can also have multiple lines2.
Synopsis
Task list (status)
Note
Modification of the checkbox is disabled
Status
“analyze” command
How to add a collapsible section in markdown
Collapsible section
bla, bla,…
List
- item 1
- item 2
- item 2.1
Table
Rank | Languages |
---|---|
1 | JavaScript |
2 | Python |
3 | SQL |
Some Javascript
function logSomething(something) {
console.log('Something', something);
}