Tutorial

How To

Wir erstellen ein Typ 1 - Quick Info Dokument.

Beispiel für Typ1

TYP 1 TITLE
###########

.. admonition:: Defintion

    Dies ist die definition des Thema / Kurze Einleitung


.. image:: url or file path here
   :alt:  Alternaitve Text
   :scale: 25


Extra Text falls benötigt

* stichpunkt
* stichpunkt

1. nummerierter stichpunkt

2. nummerierter stichpunkt

Heading
************

Text hier ... lalalla

BILD ggf

Subheading
~~~~~~~~~~~~

Text hier , **fetter text** , *kursiver text* , ``monospaced``

BILD ggf

IHK Fragenbeispiel
********************

Fragestellung als text ( screenshot von Aufgabe - bevorzugt )

.. raw:: html

   <details>
   <summary><a>Die Lösung</a></summary>

.. code-block::

   Die Lösung ist Antwort C

.. raw:: html

   </details>

.. warning::

    - LINK  : https://mein_weiterführender_Artikel

    - LINK 2  : https://mein_weiterführender_Artikel

Titel , Bild , und DefinitionsBox

Ein Titel ist immer nötig am start des Dokuments:

1. Titel

Dokument Titel
==============

Danach soll eine Definitionsbox kommen.

2. Definition

.. admonition:: Definitions Text Titel

    Defintions Box Text

Dann ein Bild (Bild / Definition auch vertauschbar)

3. Bild

.. image::  url or filepath
    :alt:  IMAGE SYNTAX von URL
    :scale: 25

4. Headings , Subheadings + Text

Heading
*******
Mein Text

Subheading
~~~~~~~~~~
Mein Text

Die Syntax Zeichen unter den Titel , Heading , Subheading … müssen immer mindestens genauso lang sein wie der Titel. ( länger ist ok)

5. IHK AUFGABE SCREENSHOT

.. image::  url or filepath

6. LÖSUNG / Aufklabar

.. raw:: html

   <details>
   <summary><a>Die Lösung</a></summary>

.. code-block::

   Die Lösung ist Antwort C

.. raw:: html

   </details>

7. Weiterführende Links

.. warning::

    - LINK  : https://mein_weiterführender_Artikel

    - LINK 2  : https://mein_weiterführender_Artikel

Subheading

Sofern weitere Unterpunkte benötigt werden könnt ihr auch noch Subheadings nutzen … 2 Ebenen sollten hoffentlich ausreichen ( Dokument Titel , Unterpunkt Headings , Subheadings )

Dokument Titel
====================

Heading 1
*********

Subheading 1
~~~~~~~~~~~~

Heading 2
*********

Subheading 2
~~~~~~~~~~~~

Fett , Kursiv , Monospace

Für Definitionen / wichtige Infos würde ich es gut finden die wichitigen Informationen fett zu schreiben.

Die syntax für fett = **inhalt hier**
Kursiv = *inhalt hier*
monospace = ``inhalt hier``

Bilder einfügen Google Drive

1. Ladet eur Bild / Screenshot als jpg oder png in den Google Drive “BILDER Ordner”

2. Macht rechtsklick auf das Bild “Get Link” , danach Copy link. aus der url (beispiel url) https://drive.google.com/file/d/1ghnpNT8LY8rkSwNuaXhNI5hFzm7IzquB/view?usp=sharing kopiert ihr diesen teil : 1ghnpNT8LY8rkSwNuaXhNI5hFzm7IzquB

und hängt ihn an diese url an : https://drive.google.com/uc?export=download&id=

3. Dann habt ihr den fertigen link https://drive.google.com/uc?export=download&id=1ghnpNT8LY8rkSwNuaXhNI5hFzm7IzquB

4. nutzt ihn in eurer .rst datei dann wie folgt

.. image:: https://drive.google.com/uc?export=download&id=1_MYgo5qgdttB5z6xALoE_73HI69VS6Ey

Bilder einfügen über IMGUR Webseite

1. Macht euren Screenshot mit Win + Shift + s

2. Geht zu https://imgur.com

3. Drückt strg + v

4. Rechtsklick auf das bild ( bildadresse kopieren)

5. dann wie gewohnt bild einfügen mit

.. image:: https://i.imgur.com/DEINLINK.png

Zusätzlich habe ich noch 2 Extensions installiert 🤘

• für Emojis : https://sphinxemojicodes.readthedocs.io/en/stable/

• und Panels : https://sphinx-panels.readthedocs.io/en/latest/

Ihr könnt dort mal reinschauen falls euch die basic formatierung nicht ausreicht ;) . Der Schnickschack sollte reichen.