Examples
Project layout
mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
This is a second header
With some text
This is a third header
Another text
This is a fourth header
More text
This is a fifth header
Fifth text again
This is a sixth header
Still some text
Code examples
Inline
This is an inline code
block where public $variable = 'some-string';
and may help in solving a problem.
Block
<?php
/** This is a PHP section */
namespace Symbiont\Core;
class Example extends BaseExample implements Exampable {
protected string|null $value = null;
public function __construct(int $value): void {
$this->value = $value;
}
}
<x-component :message="$something" :class="bliep">
{{ $slot }}
This is suppose to be bladesyntx
</x-component>
def bubble_sort(items):
for i in range(len(items)):
for j in range(len(items) - 1 - i):
if items[j] > items[j + 1]:
items[j], items[j + 1] = items[j + 1], items[j]
Tabs
This is the first tabs content
This is the second tabs content
Tabs with code blocks
This is an example on how to create an example, this isn't very much but it's just an example to show how this example with a little example notification.
Note
And this should be a note about the example on how to use the example
Table
Center | Left | Right |
---|---|---|
GET |
:material-check: | Fetch Resource |
PUT |
:material-check-all: | Update Resource |
DELETE |
:material-close: | Delete Resource |
Grid
- :fontawesome-brands-html5: HTML for content and structure
- :fontawesome-brands-js: JavaScript for interactivity
- :fontawesome-brands-css3: CSS for text running out of boxes
- :fontawesome-brands-internet-explorer: Internet Explorer ... huh?
Notes
Note
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
Warning
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
Example
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
Quote
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
Left or right positioned notes
Lorem ipsum
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla et euismod nulla. Curabitur feugiat, tortor non consequat finibus, justo purus auctor massa, nec semper lorem quam in massa.
Everything written here will be on the left and the infobox will be right from this text. This is very usefull to structure small parts of information unwillingly using blocks. Everything written here will be on the left and the infobox will be right from this text. This is very usefull to structure small parts of information unwillingly using blocks. Everything written here will be on the left and the infobox will be right from this text. This is very usefull to structure small parts of information unwillingly using blocks. Everything written here will be on the left and the infobox will be right from this text. This is very usefull to structure small parts of information unwillingly using blocks. Everything written here will be on the left and the infobox will be right from this text. This is very usefull to structure small parts of information unwillingly using blocks.
Checklist
- Lorem ipsum dolor sit amet, consectetur adipiscing elit
- Vestibulum convallis sit amet nisi a tincidunt
- In hac habitasse platea dictumst
- In scelerisque nibh non dolor mollis congue sed et metus
- Praesent sed risus massa
- Aenean pretium efficitur erat, donec pharetra, ligula non scelerisque