Zum Inhalt

HTML und Markdown

Diverse Formatierungen mit HTML und Markdown

Beispiele mit Ansicht und Markdown

(durch extension - attr_list und - md_in_html möglich)


mkdocs-material reference


Test mit Kommentaren

Kommentare sind nicht sichtbar…

Kommentare sind nicht sichtbar...

<!-- Kommentar -->

[This is a comment]::

[//]: # (This is a comment.)

[comment]: <> (This is a comment, it will not be included)

[comment]: # (This is a comment, it will not be included)

Content Tab

Inhalt der ersten Spalte.

Inhalt der zweiten Spalte.

Inhalt der dritten Spalte.

Inhalt der vierten Spalte.

=== "Spalte 1"
    Inhalt der ersten Spalte.

=== "Spalte 2"
    Inhalt der zweiten Spalte.

=== "Spalte 3"
    Inhalt der dritten Spalte.

=== "Spalte 4"
    Inhalt der vierten Spalte.

Block mit 2 Spalten

mit extension `- pymdownx.blocks.html``

Spalten lassen sich mit div[style="float: left; width: 45%; margin-right: 5%;"]in der Breite und beim Abstand anpassen…

Markdown Formatierung innerhalb der Spalten ist möglich.

Allerdings kein Umbruch auf kleinen Dispays…?


Version 1

Hier steht der Inhalt der linken Spalte. Sie können hier ganz normal Text, Bilder oder Listen einfügen.

Linke Spalte

Bild

Markdown Formatierung ist hier möglich

Hier steht der Inhalt der rechten Spalte. Abstand auf 5% mit margin-right (CSS Style) leider kein Umbruch bei kleinen Displays

Rechte Spalte

Bild

Markdown Formatierung ist hier möglich

content.md
/// html | div[style="float: left; width: 45%; margin-right: 5%;"]
Hier steht der Inhalt der **linken** Spalte. Sie können hier ganz normal Text, Bilder oder Listen einfügen.

#### Linke Spalte

![Bild](https://dummyimage.com/300x200/eee/aaa)

***Markdown*** *Formatierung* ist hier **möglich**
///

/// html | div[style="float: left; width: 45%;"]
Hier steht der Inhalt der **rechten** Spalte. 
Abstand auf 5% mit margin-right (CSS Style)

#### Rechte Spalte

![Bild](https://dummyimage.com/300x200/eee/aaa)

***Markdown*** *Formatierung* ist hier **möglich**
///

/// html | div[style="clear: both;"]
///

Version 2

[markdown here]

Linke Spalte

Bild

Markdown Formatierung ist hier möglich Bild mit width=100 und align=left

Abstand noch über CSS style definieren?

[markdown here]

Rechte Spalte

Bild

Markdown Formatierung ist hier möglich

content.md
/// html | div[style='float: left; width: 45%; margin-right: 5%;']
[markdown here]

#### Linke Spalte

![Bild](https://dummyimage.com/300x200/eee/aaa){ width=100 align=left }


***Markdown*** *Formatierung* ist hier **möglich**
Bild mit width=100 und align=left

Abstand noch über CSS style definieren?
///

/// html | div[style='float: right; width: 45%; margin-right: 5%;']
[markdown here]

#### Rechte Spalte

![Bild](https://dummyimage.com/300x200/eee/aaa){ width=200 }

***Markdown*** *Formatierung* ist hier **möglich**
///

/// html | div[style='clear: both;']
///

Version 2 - angepasst - entspricht jetzt Version 1…


Grid

Test mit “grid” class und markdown

funktioniert mit <div class="grid" markdown="1">

(in jedem <div> muss markdown="1" eingefügt werden)

Vorteil: wird auf kleinen Displays umgebrochen

Linke Spalte

Bild

Markdown Formatierung ist hier möglich

Inhalt hier…

Rechte Spalte

Bild

Markdown Formatierung ist hier möglich

Inhalt hier…

content.md
<div class="grid" markdown="1">

<div markdown="1"> <!-- Spalte 1 -->

<h3>Linke Spalte</h3>

![Bild](https://dummyimage.com/300x200/eee/aaa)

 ***Markdown*** *Formatierung* ist hier **möglich**

Inhalt **hier...**
</div>

<div markdown="1"> <!-- Spalte 2 -->

### Rechte Spalte

![Bild](https://dummyimage.com/300x200/eee/aaa)

 ***Markdown*** *Formatierung* ist hier **möglich**

Inhalt **hier...**
</div>

</div>

Grid mit Blocks

Version mit Blocks und Markdown zwischen div

  • Sed sagittis eleifend rutrum
  • Donec vitae suscipit est
  • Nulla tempor lobortis orci
  1. Sed sagittis eleifend rutrum
  2. Donec vitae suscipit est
  3. Nulla tempor lobortis orci
Content tabs
=== "Unordered list"

    * Sed sagittis eleifend rutrum
    * Donec vitae suscipit est
    * Nulla tempor lobortis orci

=== "Ordered list"

    1. Sed sagittis eleifend rutrum
    2. Donec vitae suscipit est
    3. Nulla tempor lobortis orci

content.md
<div class="grid" markdown>

=== "Unordered list"

    * Sed sagittis eleifend rutrum
    * Donec vitae suscipit est
    * Nulla tempor lobortis orci

=== "Ordered list"

    1. Sed sagittis eleifend rutrum
    2. Donec vitae suscipit est
    3. Nulla tempor lobortis orci

``` title="Content tabs"
=== "Unordered list"

    * Sed sagittis eleifend rutrum
    * Donec vitae suscipit est
    * Nulla tempor lobortis orci

=== "Ordered list"

    1. Sed sagittis eleifend rutrum
    2. Donec vitae suscipit est
    3. Nulla tempor lobortis orci
```

</div>

Grid Cards

Test mit <div class="grid cards" markdown>

  • Set up in 5 minutes


    markdown here
    Install mkdocs-material with pip and get up and running in minutes

    Getting started

  • It’s just Markdown


    markdown here
    Focus on your content and generate a responsive and searchable static site

    Reference

  • Made to measure


    Change the colors, fonts, language, icons, logo and more with a few lines

    Customization

  • Open Source, MIT


    Material for MkDocs is licensed under MIT and available on [GitHub]

    License


content.md
<div class="grid cards" markdown>

-   :material-clock-fast:{ .lg .middle } __Set up in 5 minutes__

    ---
    ![markdown here](images/screenshot-poicloud-laptop-01.webp){: style="width:350px"}<br>
    Install [`mkdocs-material`](#) with [`pip`](#) and get up
    and running in minutes

    [:octicons-arrow-right-24: Getting started](#)

-   :fontawesome-brands-markdown:{ .lg .middle } __It's just Markdown__

    ---
    ![markdown here](images/screenshot-poiconnect-controller-01.webp){: style="width:350px"}<br>
    Focus on your content and generate a responsive and searchable static site

    [:octicons-arrow-right-24: Reference](#)

-   :material-format-font:{ .lg .middle } __Made to measure__

    ---

    Change the colors, fonts, language, icons, logo and more with a few lines

    [:octicons-arrow-right-24: Customization](#)

-   :material-scale-balance:{ .lg .middle } __Open Source, MIT__

    ---

    Material for MkDocs is licensed under MIT and available on [GitHub]

    [:octicons-arrow-right-24: License](#)

</div>

content.md
# Documentation

<div class="grid cards" markdown>
-   <a class="card-link" href="https://www.github.com" target="_blank" rel="noreferrer">
        :fontawesome-brands-github:{ .xxxl .middle .center }
        <span class="card-title center">GitHub</span>
    </a>
</div>

Grid Cards komplett als Link - Anpassung in der Markdown Datei und in extra.css erforderlich

extra.css
// extra.css

a.card-link center {
    width: fit-content;
    display: block;
    margin: 0 auto;
}

a.card-link .card-title {
    font-size: 1.5em;
}

a.card-link {
    color: initial; // Make cards have white text until hovered.
}

Bei Bedarf noch testen…

Grid Card als Links


Beispieltext

Eiusmod tempor elit et excepteur. Culpa commodo ullamco irure esse fugiat exercitation fugiat deserunt ad. Amet deserunt aute laborum aute in adipisicing sunt consectetur deserunt. Culpa sit irure non tempor. Id quis irure veniam aliqua consequat consequat deserunt minim sunt qui qui incididunt culpa pariatur. Consectetur dolore nisi reprehenderit occaecat tempor voluptate deserunt ex tempor ut eiusmod tempor consectetur ut. Ad occaecat enim id amet velit eu anim.


Info Boxen

Note

Note - nur Typ - kein Titel - Beispieltext

!!! note
    Note - nur Typ - kein Titel - Beispieltext

Note - kein Typ - kein Titel - Beispieltext

!!! note ""
    Note - kein Typ - kein Titel - Beispieltext

Notiz

Note - Titel=Notiz - Beispieltext

!!! note "Notiz"
    Note - Titel=Notiz - Beispieltext

Notiz

Note - ausklappbar (mit ???) - Titel=Notiz - Beispieltext

??? note "Notiz"
    Note - ausklappbar (mit ???) - Titel=Notiz - Beispieltext

Notiz

Note - als Standard geöffnet (mit +) - ausklappbar - Titel=Notiz - Beispieltext

???+ note "Notiz"
    Note - als Standard geöffnet (mit +) - ausklappbar - Titel=Notiz - Beispieltext

Hinweis

abstract - Titel=Hinweis - Beispieltext

!!! abstract "Hinweis"
    abstract - Titel=Hinweis - Beispieltext

Info

info - Titel=Info - Beispieltext

!!! info "Info"
    info - Titel=Info - Beispieltext

Tip

tip - Titel=Tip - Beispieltext

!!! tip "Tip"
    tip - Titel=Tip - Beispieltext

Resultat

success - Titel=Resultat - Beispieltext

!!! success "Resultat"
    success - Titel=Resultat - Beispieltext

Frage

question - Titel=Frage - Beispieltext

!!! question "Frage"
    question - Titel=Frage - Beispieltext

Warnung

warning - Titel=Warnung - Beispieltext

!!! warning "Warnung"
    warning - Titel=Warnung - Beispieltext

Fehler

failure - Titel=Fehler - Beispieltext

!!! failure "Fehler"
    failure - Titel=Fehler - Beispieltext

Gefahr

danger - Titel=Gefahr - Beispieltext

!!! danger "Gefahr"
    danger - Titel=Gefahr - Beispieltext

Bug

bug - Titel=Bug - Beispieltext

!!! bug "Bug"
    bug - Titel=Bug - Beispieltext

Beispiel

example - Titel=Beispiel - Beispieltext

!!! example "Beispiel"
    example - Titel=Beispiel - Beispieltext

Zitat

quote - Titel=Zitat - Beispieltext

!!! quote "Zitat"
    quote - Titel=Zitat - Beispieltext

FAQ Version 1

Wie kann ich mich bei der POICloud anmelden?
Anmeldung bei der POICloud

mit Mailadresse und Passwort

Wie kann ich mich bei der POICloud anmelden?
Anmeldung bei der POICloud

mit Mailadresse und Passwort

Wie kann ich mich bei der POICloud anmelden?
Anmeldung bei der POICloud

mit Mailadresse und Passwort

Wie kann ich mich bei der POICloud anmelden?
Anmeldung bei der POICloud

mit Mailadresse und Passwort

Wie kann ich mich bei der POICloud anmelden?
Anmeldung bei der POICloud

mit Mailadresse und Passwort

Wie kann ich mich bei der POICloud anmelden?
Anmeldung bei der POICloud

mit Mailadresse und Passwort

Nachteil: Titel von Info Box kann nicht direkt verlinkt werden


FAQ Version 2


Wie kann ich mich bei der POICloud anmelden?

Antwort: mit Mailadresse und Passwort


Wie kann ich mich bei der POICloud anmelden?

Antwort: mit Mailadresse und Passwort


Wie kann ich mich bei der POICloud anmelden?

Antwort: mit Mailadresse und Passwort


Wie kann ich mich bei der POICloud anmelden?

Antwort: mit Mailadresse und Passwort


Wie kann ich mich bei der POICloud anmelden?

Antwort: mit Mailadresse und Passwort


FAQ mit :target

Version mit :target - braucht noch Anpassungen für dark/light mode in extra.css

(ist auskommentiert - evtl. zum Testen mit _v1 und _v2 benennen?)


FAQ mit Flexbox

Version mit CSS Flexbox

md_in_html funktioniert hier nicht beim header…?

Anweisung in der extra.css wegen br ist z.Zt. auskommentiert

evtl. wieder zurück zur 1. Version ohne zusätzliche divs…?

This is the content for item 1. It expands when clicked.


This is the content for item 2. You can place any HTML here.


This is the content for item 3. Click again to collapse.


Info zu css-accordions