MDX Components für moderne Inhaltssysteme

Dieser Text erklärt React Components in MDX. Sie können diese Bausteine immer wieder verwenden. Wir zeigen Ihnen Beispiele für interaktive Inhalte.

Auf einen Blick

  • MDX verbindet Markdown mit React Components. Dadurch können Sie interaktive Inhalte in einfache Texte einbauen.
  • Wir empfehlen diese Components: Tabs, Accordion, Charts und DataTable. Auch Mermaid-Diagramme, Video-Embeds, Callouts und Referenzen sind wichtig.
  • Mermaid unterstützt sehr viele Diagramme. Dazu gehören Flowchart, Sequence, Class und State. Auch ER, User Journey, Gantt, Mindmap, Sankey und Architecture funktionieren.
  • Eine Anleitung für das KI-Sprachmodell erklärt den guten Schreibstil. Sie hilft Ihnen bei der Auswahl der Bausteine. Sie bietet auch eine Prüfliste für die Veröffentlichung.

MDX verbindet die Textsprache Markdown mit React Components. React Components sind praktische Bausteine für Internetseiten. Dadurch können Sie interaktive Elemente in normale Texte einbauen.

Das System verbindet einfaches Schreiben in Markdown mit moderner Technik. Fachleute nennen diese Technik Frontend-Frameworks.


Inhaltsverzeichnis  


Teil 1: Markdown Grundlagen 

Überschriften  

Überschrift 1 

Überschrift 2  

Überschrift 3  

Überschrift 4

Überschrift 5
Überschrift 6

Abkürzungen  

Hier sehen Sie Abkürzungen mit Erklärungen. Das ist gut für die Barrierefreiheit.

Das W3C macht die Regeln für HTML. Moderne Internetseiten nutzen CSS für das Aussehen. Sie nutzen JS für viele Funktionen.

Gutes HTML ist wichtig für die Suche im Internet. Das nennt man auch SEO. Eine API tauscht Daten zwischen Programmen aus. Sie nutzt dafür oft REST oder GraphQL.

Tipp: Bewegen Sie die Maus über die Abkürzungen. Dann sehen Sie die ganze Bedeutung.


Language Spans  

Markieren Sie Wörter aus anderen Sprachen richtig. Das hilft Vorleseprogrammen. Und es hilft Suchmaschinen.

Die Benutzeroberfläche heißt User Interface. Sie sollte einfach zu bedienen sein. Ein gutes Erlebnis für Nutzer heißt User Experience.

Wir nutzen die Regel Don't Repeat Yourself. Die Abkürzung ist DRY. Das bedeutet: Wiederholen Sie sich nicht.

Ein Pull Request ist ein Vorschlag für Änderungen. Wir prüfen den Code. Das nennt man Code Review. Danach fügen wir den neuen Code ein.

Das Veröffentlichen von Software heißt Deployment. Wir nutzen dafür automatische Programme. Das nennt man Continuous Integration.

Im Café gibt es Cappuccino und Croissants.

Ihre Vorteile:

  • Vorleseprogramme sprechen die Wörter richtig aus.
  • Suchmaschinen verstehen die Sprache besser.

Listen  

Liste mit Punkten:

  • Erster Punkt
  • Zweiter Punkt
    • Ein Unterpunkt
    • Noch ein Unterpunkt

Liste mit Zahlen:

  1. Erster Schritt
  2. Zweiter Schritt
    1. Ein Schritt darunter
    2. Noch ein Schritt darunter

Hier ist ein Link zu unserer Internetseite. Und hier ist ein Link mit einem Titel.


Blockquotes  

Blockquotes sind besondere Textblöcke. Sie sind sehr gut für Zitate. Sie heben wichtige Informationen deutlich hervor.

Beispiel 1: Ein einfaches Zitat

Das ist ein Blockquote. Sie können ihn für Zitate nutzen. Er zeigt wichtige Hinweise. Er hebt Aussagen gut hervor.

Ein Blockquote kann mehrere Absätze haben.

Beispiel 2: Ein Zitat von einem Experten

"Der beste Weg in die Zukunft: Erfinden Sie diese Zukunft selbst."

— Alan Kay, Informatiker

Beispiel 3: Ein wichtiger Hinweis

Wichtig: Next.js 15 nutzt Server Components. Trennen Sie den Server-Code und den Client-Code streng voneinander. Nutzen Sie keine Browser-APIs in Server Components.


Codeblöcke  

Hier sehen Sie Codeblöcke für verschiedene Programmiersprachen. Die Farben machen den Code gut lesbar. Das nennt man Syntax-Highlighting.

Code im Text: const x = 42 oder npm install react

Beispiel 1: TypeScript

Beispiel 2: React Component (JSX)

Beispiel 3: CSS Styling

Beispiel 4: Shell Befehle

Beispiel 5: JSON Einstellungen

Markdown Schreibweise:


Teil 2: Interaktive UI Components 

Tabs  

Tabs ordnen ähnliche Inhalte. Dadurch ist die Seite am Anfang übersichtlicher. Das macht das Lesen einfacher.


Accordion  

Ein Accordion ist ein Element zum Aufklappen. Sie nutzen es oft für häufige Fragen. So ordnen Sie Informationen gut und übersichtlich.


Progress Bars  

Progress Bars ist englisch. Es bedeutet: Balken für den Fortschritt. Damit zeigen Sie Ihre Fähigkeiten als Bild. Sie zeigen damit, wie weit eine Aufgabe ist. Oder Sie zeigen damit wichtige Leistungswerte.

React / Next.js95%
TypeScript90%
TYPO3 / PHP85%
DevOps / Cloud80%

Zeitleiste  

Sie können wichtige Ziele von Ihrem Projekt zeigen. Oder Sie zeigen einen Plan für die Entwicklung. Die Anzeige in der Zeitleiste ist sehr übersichtlich.

Wechsel auf Next.js 15

Wir wechseln auf React Server Components und App Router.

Start der Component Library

Wir veröffentlichen unsere eigene Component Library. Das ist eine Sammlung von Bausteinen.

Einbau von MDX

Wir nutzen MDX für die Verwaltung von unseren Inhalten.

Card Grid  

Diese Karten zeigen Funktionen, Angebote oder geordnete Daten.

Leistung

Server Components machen die JavaScript-Dateien um bis zu 40 Prozent kleiner.

Sichere Typen

TypeScript ist vollständig eingebaut. Das Programm erkennt Typen ganz automatisch.

Hilfen für Entwickler

Sie nutzen Hot Module Replacement. Das System unterstützt ESLint und Prettier.


Tooltip  

Tooltips zeigen wichtige Informationen an. Sie stören Sie nicht beim Lesen.

Tooltips sind sehr nützlich für technische Abkürzungen oder Fachbegriffe.

Besonderheiten:

  • Sie erfüllen die Regeln für Barrierefreiheit (WCAG 2.1 AA).
  • Sie können die Tooltips mit der Tastatur bedienen.
  • Die Tooltips funktionieren auch auf dem Smartphone.
  • Sie passen ihre Position automatisch an.

Teil 3: Darstellung von Daten 

Charts  

Hier sehen Sie interaktive Diagramme. Interaktiv bedeutet: Sie können die Diagramme mit der Maus bedienen. Wir bauen diese Diagramme mit der Technik Recharts.

Line Chart  

Bar Chart  

Area Chart  

Pie Chart  

Einstellungen für das Diagramm (Props):

  • type: Die Art von dem Diagramm ('line', 'bar', 'area' oder 'pie').
  • data: Eine Liste mit Ihren Daten.
  • xAxisKey: Der Name für die untere Linie (X-Achse).
  • lines/bars/areas: Eine Liste mit den Werten für das Diagramm.
  • dotShapes: Die Form von den Punkten.
  • colors: Eine eigene Liste mit Farben.
  • Weitere Einstellungen sind: height, showGrid, showLegend und yAxisUnit.

Datentabellen  

Hier sehen Sie schön gestaltete Tabellen. Es gibt verschiedene Arten von Tabellen.

Normale Tabelle in Markdown  

FrameworkTypeRenderingPerformance
Next.jsReactSSR/SSG/ISR
Nuxt 3VueSSR/SSG
SvelteKitSvelteSSR/SSG

Die Komponente DataTable  

MetricBeforeAfterImprovement
First Contentful Paint2.4s0.8s+67%
Largest Contentful Paint4.2s1.2s+71%
Time to Interactive5.8s2.1s+64%

Varianten: default, striped, bordered, minimal


Vergleichstabellen  

Hier sehen Sie besondere Tabellen. Sie können damit Funktionen gut vergleichen. Die Tabellen zeigen ein Ja oder Nein.

FeatureTYPO3WordPressDrupal
Für große Firmen
Mehrere Internetseiten
Genaue Rechte
Eingebaute Versionen
LernaufwandHochLeichtMittel

Teil 4: Mermaid Diagramme 

Sie bauen technische Diagramme direkt in den Text ein. Sie können die Diagramme anklicken und größer machen. Die Farben sind für alle Menschen gut lesbar.

Alle Arten von Mermaid Diagrammen

Mermaid.js bietet mehr als 15 Arten von Diagrammen. Wir zeigen Ihnen hier die wichtigsten Diagramme. Wir geben Ihnen auch Beispiele dazu.


Flowchart  

Ein Flowchart ist ein Ablaufplan. Damit zeigen Sie Abläufe und Entscheidungen als Bild.

Ablauf von Next.js ISR (Incremental Static Regeneration)

Mögliche Richtungen für das Bild:

  • TD: Von oben nach unten
  • LR: Von links nach rechts
  • BT: Von unten nach oben
  • RL: Von rechts nach links

Sequence Diagram  

Ein Sequence Diagram ist ein Ablaufdiagramm. Es zeigt Schritte in einer bestimmten Reihenfolge. Sie sehen dabei genau: Was passiert wann? Das ist wichtig für Abfragen von Daten im Internet.

Ablauf von einer Datenabfrage über den Server

Regeln für den Code:

  • ->> macht einen durchgehenden Pfeil.
  • -->> macht einen gestrichelten Pfeil.
  • activate und deactivate zeigen die Dauer von einem Prozess.
  • Fachleute nennen diese Dauer auch Lebenslinie.

Klassendiagramme  

UML-Klassendiagramme zeigen den Bauplan von einer Software. Das nennt man auch Softwarearchitektur.

Klassenstruktur von einem Blog

Beziehungen:

  • --> (Verbindung)
  • --|> (Vererbung)
  • ..> (Abhängigkeit)
  • --* (Zusammensetzung)

State Diagram  

Damit planen Sie Arbeitsabläufe. Sie zeigen damit verschiedene Zustände von einem Ablauf.

Zustände für die Veröffentlichung von Inhalten

Schreibweise: Das Zeichen [*] steht für den Start und für das Ende. Das Zeichen --> zeigt einen Wechsel. Der Text für den Wechsel steht nach dem Doppelpunkt :.


Entity-Relationship-Diagramm  

Ein Entity-Relationship-Diagramm zeigt den Aufbau von einer Datenbank. Sie können damit die Modelle der Daten gut dokumentieren.

Aufbau der Datenbank für einen Blog

Kardinalitäten: Das Fachwort bedeutet: Wie viele Verbindungen gibt es?

  • || (genau 1)
  • o{ (viele)
  • |{ (1 oder mehr)
  • o| (0 oder 1)

User Journey  

Hier zeigen Sie die Erfahrungen von Ihren Nutzern. Sie zeigen alle Schritte vom Besucher zum Kunden. Das nennt man User Journey.

Der Weg vom ersten Kontakt bis zum Kunden

Die Schreibweise: Nutzen Sie das Wort section für die Phasen. Schreiben Sie eine Zahl von 1 bis 5 nach der Aufgabe. Das ist die Bewertung. Schreiben Sie die beteiligten Personen danach auf.


Gantt Chart  

Damit planen Sie den Zeitplan für Ihr Projekt. Sie planen damit auch wichtige Zwischenziele.

Zeitplan für das Projekt mit wichtigen Zwischenzielen

Status: done (fertig), active (aktiv), crit (kritisch), milestone (Zwischenziel)


Pie Chart (Mermaid)  

Damit machen Sie Statistiken sichtbar. Sie zeigen damit eine Aufteilung in Prozent.

Verteilung der Browser im Internet

Gut zu wissen: Der Befehl showData zeigt die Zahlen in Prozent an. Mit dem Befehl %%{init}%% machen Sie eigene Farben.


Git Graph  

Sie können Branching-Strategien als Bild zeigen. Sie können auch Release-Flows als Bild zeigen.

Bild von einer Branching-Strategie und einem Release-Flow

Wichtige Wörter: branch, checkout, commit, merge, tag, type: HIGHLIGHT


Mindmap  

So zeigen Sie Ihr Wissen sehr übersichtlich. Sie können damit gut Ideen sammeln. Sie können auch eine feste Ordnung zeigen.

Übersicht über die Technik

Der Aufbau: Sie rücken den Text ein. Damit machen Sie die Ordnung klar. Sie schreiben root((Text)) für den Punkt in der Mitte.


Zeitleiste (Mermaid)  

Hier sehen Sie Ereignisse in der richtigen Reihenfolge der Zeit.

Die Entwicklung vom Internet im Lauf der Zeit

Schreibweise: Nutzen Sie section für bestimmte Zeiträume. Nutzen Sie Jahr : Event für die einzelnen Ereignisse.


Quadrant Chart  

Ein Quadrant Chart hat 4 Felder. Damit können Sie Dinge gut bewerten. Sie sehen sofort, was am wichtigsten ist.

Bewertung von Technologien nach Nutzen und Aufwand

Regeln für den Code: Sie benennen die Linien mit x-axis und y-axis. Sie geben den 4 Feldern einen Namen. Sie schreiben die Punkte als [x, y]. Die Zahlen liegen zwischen 0 und 1.


Sankey Diagram  

Dieses Diagramm zeigt, wie Dinge fließen. Es zeigt auch, wie Sie Mittel verteilen.

Aufteilung vom Budget für ein Internetprojekt (in Tausend Euro)

Schreibweise: Source,Target,Value – Das bedeutet: Quelle, Ziel und Wert. Das bestimmt den Fluss zwischen den Punkten.

Achtung: Test-Version

Sankey Diagrams sind in Mermaid noch in einer Testphase. Die Schreibweise kann sich in Zukunft noch ändern.


Architekturdiagramme  

Sie können den Aufbau von Systemen als Schaubild zeigen.

Moderner Aufbau von Internetseiten

Schreibweise:

  • Das Wort subgraph steht für Gruppen.
  • Die Buchstaben TB stehen für eine Richtung von oben nach unten.
  • Die Zeichen [()] zeichnen einen Zylinder für Datenbanken.

XY Chart  

Dieses Diagramm zeigt Daten als Linien oder Balken.

Die Ladezeit der Internetseite im Verlauf der Zeit

So bauen Sie das Diagramm auf:

  • Nutzen Sie x-axis und y-axis für die Bereiche.
  • Nutzen Sie bar für Balken.
  • Nutzen Sie line für Linien.

C4 Diagramm  

Ein C4 Diagramm zeigt den Aufbau von Software. Es zeigt die Software auf verschiedenen Ebenen. Die Ebenen heißen Context, Container und Component.

C4 System Context Diagram

Elemente: Person, System, System_Ext, Container und Component. Das Element Rel zeigt die Beziehungen.


Requirement Diagram  

Dieses Diagramm zeigt Anforderungen. Es zeigt auch die Beziehungen zwischen den Anforderungen.

Sicherheitsanforderungen für die Anmeldung

Hinweis: Requirement Diagrams nutzen die Struktur von Flussdiagrammen. Das funktioniert besser mit MDX. Sie können Anforderungen und Elemente in Gruppen zusammenfassen. Nutzen Sie dafür den Befehl Subgraph. Pfeile zeigen die Beziehungen zwischen den Elementen. Beispiele für solche Beziehungen sind satisfies oder derives.


Zusammenfassung für Mermaid  

Art vom DiagrammWofür Sie es nutzen
FlowchartAbläufe, Algorithmen, Entscheidungsbäume
SequenceAbläufe von Schnittstellen, Austausch zwischen Diensten
ClassStrukturen von Objekten, Modelle für Fachbereiche
StateArbeitsabläufe, Zustandsautomaten
ERAufbau von Datenbanken
User JourneyWege von Nutzern, Erfahrungen von Kunden
GanttPlanung von Projekten, Zeitpläne
PieVerteilung in Prozent
Git GraphStrategien für Branches in Git
MindmapIdeen sammeln, feste Rangordnungen
TimelineEreignisse in zeitlicher Reihenfolge
QuadrantEinteilung nach Wichtigkeit
SankeyDarstellung von Mengen und Flüssen
BlockAufbau von Systemen
XY ChartDarstellung von Daten
C4Aufbau von Software
RequirementArbeit mit Anforderungen

Teil 5: Medien und Einbindungen 

Video Player  

Sie können eigene Videos direkt auf der Internetseite zeigen. Das ist sehr gut für Beispiele und Erklärungen.

Props: controls, poster, autoplay, loop, muted, preload


Bildergalerie  

Sie können auf die Bilder klicken. Dann öffnet sich eine große Ansicht. Diese Ansicht nennt man Lightbox. Die Technik dahinter heißt React Context.

Die Kirche St Martin-in-the-Fields mit Säulen

St Martin-in-the-Fields, London

Die Markthalle Covent Garden Market von innen

Covent Garden Market

Der Platz in Covent Garden beim Sonnenuntergang

Sonnenuntergang in Covent Garden

Die National Gallery am Trafalgar Square am Abend

National Gallery, Trafalgar Square

Die Nelsonsäule am Trafalgar Square am Abend

Nelsonsäule

Ein beleuchteter Brunnen am Trafalgar Square in der Nacht

Brunnen am Trafalgar Square

Ein Vortrag über TYPO3 und Caching

Vortrag auf dem TYPO3 Camp London

Ein roter Zug der Londoner U-Bahn fährt ein

U-Bahn in London

Diese Funktionen gibt es:

  • Sie können die Bilder mit einem Klick vergrößern.
  • Sie können die Bilder mit der Tastatur steuern. Zum Beispiel mit den Pfeiltasten und der ESC-Taste.
  • Sie können auf dem Handy über die Bilder wischen.
  • Die Bilder laden erst, wenn Sie diese wirklich ansehen. Das nennt man Lazy Loading.
  • Es gibt kleine Vorschaubilder.

Videos von YouTube einfügen  

Wir fügen Videos sicher für den Datenschutz ein. YouTube speichert vorher keine Cookies. Das passiert erst, wenn Sie klicken.

Video abspielen
Lädt YouTube & setzt Cookies

Klick lädt YouTube (Datenschutz)

Funktionen:

  • Wir nutzen den Code react-lite-youtube-embed.
  • Wir laden das Video über die Adresse youtube-nocookie.com.
  • Ein Text auf dem Video warnt Sie vor Cookies.

Zitat von Twitter oder X  

Hier sehen Sie einen Beitrag von Twitter. Wir speichern dabei keine Daten von Ihnen. Wir nutzen auch keine Cookies.

Statisch gerendert - keine Cookies, kein Tracking

Die Vorteile sind:

  • Der Code besteht nur aus HTML.
  • Wir nutzen absolut keine Cookies.
  • Die Anzeige erscheint sofort.
  • Es gibt einen Link zum Original.

GitHub Repository Card  

Diese Karte zeigt Informationen über ein Repository. Der Server lädt diese Informationen. Ihr Browser macht dafür keine eigenen Aufrufe.

Die Eigenschaften:

  • Es ist eine Komponente für den Server.
  • Der Server prüft die Daten alle 60 Minuten neu.
  • Ihr Browser braucht dafür kein JavaScript.
  • Das System unterstützt die Technik ISR.

Audio und Musik einfügen  

Sie können Inhalte von Spotify und YouTube ganz einfach einfügen. Das gilt für Musik und für Videos.

Auf die Rechte achten

Prüfen Sie immer vorher: Darf ich diesen Inhalt auf meiner Internetseite zeigen? Sie brauchen das Recht dafür.

Inhalte von Spotify einfügen  

Sie können verschiedene Dinge von Spotify direkt auf der Internetseite anzeigen. Zum Beispiel:

  • einzelne Lieder
  • ganze Alben
  • Listen mit Musik
  • Podcasts

Weitere Beispiele:

Einstellungen (Props):

  • uri: Das ist die genaue Erkennungsnummer bei Spotify. Sie finden diese Nummer in der Internetadresse von Spotify.
  • type: Die Art von dem Inhalt. Erlaubte Werte sind: 'track', 'album', 'playlist', 'episode' oder 'show'.
  • height: Die Höhe der Anzeige in Pixeln. Diese Angabe ist freiwillig.
  • compact: Das ist eine kleinere Ansicht. Sie ist genau 80 Pixel hoch.

Inhalte von YouTube einfügen  

Sie können auch Videos und Töne von YouTube einfügen. Dafür nutzen Sie den Baustein YouTubeEmbed. Lesen Sie dazu den Abschnitt Video Player weiter oben.


Teil 6: Aufbau der Inhalte 

Callout Components  

Callouts sind besondere Kästen für Text. Es gibt diese Kästen in 5 Arten.

Information

Hier stehen normale Informationen. Hier stehen auch technische Details.

Erfolg

Dieser Kasten zeigt einen Erfolg. Die Aktion hat gut funktioniert.

Warnung

Dieser Kasten zeigt eine Warnung. Es kann Probleme geben.

Fehler

Dieser Kasten zeigt schwere Fehler. Er zeigt auch sogenannte Breaking Changes. Das sind Änderungen, die alten Code kaputt machen.

Technischer Tipp

Hier finden Sie gute Tipps. Diese Tipps machen Ihre Arbeit besser.

Arten: info, success, warning, error, tip


TechResourceCallout  

Dieser Kasten ist für technische Verweise. Er ist für Texte für Entwickler und Entwicklerinnen. Sie können damit gut auf Dateien bei GitHub verweisen. Oder Sie verweisen auf die Beschreibung von einer Schnittstelle. Eine Schnittstelle für Programme heißt in der Technik auch API. Der Kasten passt sehr gut für schwere technische Texte.

Für technisch Interessierte

Deepfake-Detection Skill

Dieser Text erklärt genaue Prüfmethoden für Bilder. Dazu gehören unsichtbare Spuren vom Kamerasensor. Er erklärt auch Fehler durch das Verkleinern von Bildern. Das ist perfekt für Entwickler und Entwicklerinnen. Diese Personen bauen Programme für das Erkennen von Fälschungen.

Auf GitHub öffnen

Eigenschaften (Props):

EigenschaftTypStandardBeschreibung
titlestringPflichtDer Titel von der Quelle.
childrenReactNodePflichtDer Text in dem Kasten.
urlstringPflichtDer Link zu der Quelle.
linkTextstring"Auf GitHub öffnen"Der Text auf dem Knopf.
headerstring"Für technisch Interessierte"Die Überschrift.
iconstring"code"Der Name von dem Lucide-Symbol.

Mehr Beispiele:

Für TYPO3-Administratoren

TYPO3 Security Hardening

Das ist eine genaue Prüfliste für sichere TYPO3-Seiten. TYPO3 ist ein System für Internetseiten. Die Liste erklärt wichtige Rechte für Dateien. Sie erklärt auch sichere Verbindungen und Kopfdaten.

Anleitung öffnen

PDF Download  

Es gibt 3 Arten für den PDF Download. Sie sehen immer einheitlich aus.

Standard  

Wahr oder falsch im Internet?(2.3 MB)

Saferinternet.at Material für den Unterricht

Kompakt (im Text)  

Sie können den Download in den Text einbauen: Material als PDF(2.3 MB). Das passt sehr gut für normalen Text.

Karte  

Komplettes Material für den Unterricht(2.3 MB)

Es gibt 17 Themen mit Übungen und Informationen.


Subpage Navigator  

Hier sehen Sie Links zu ähnlichen Unterseiten. Diese Links sind übersichtlich geordnet.


Teil 7: Referenzen und Quellen 

Manche Artikel sind sehr lang und wissenschaftlich. Dafür haben wir ein System für die Quellenangaben. Eine Quelle zeigt, woher eine Information kommt. Das System ordnet die Quellen automatisch. Das System macht auch automatisch Überschriften für die Kapitel.

Die Datenbank als einziger Ort für alle Informationen

Wir speichern alle Quellen in einer Datenbank. Die Datenbank heißt PostgreSQL. Im Text rufen wir die Quellen über eine Nummer auf. Diese Nummer heißt Datenbanknummer (<Citation id="db-123" />). Am Ende vom Artikel steht eine Liste mit allen Quellen. Das System erstellt diese Liste ganz automatisch. Dafür nutzt das System die Komponente ArticleReferencesSection. Sie können neue Quellen ganz einfach einfügen. Nutzen Sie dafür das Skript scripts/sync-blog-references.ts. Oder Sie nutzen den Bereich für Administratoren.


AllReferencesFlat  

Diese Variante arbeitet mit einer Datenbank. Sie lädt die Referenzen aus der PostgreSQL-Datenbank. Danach zeigt sie die Referenzen mit Zwischenüberschriften an.

Props:

PropTypStandardBeschreibung
titlestring"Referenzen & Quellen"Überschrift von dem Bereich
descriptionstring-Text zur Einleitung (Freiwillig)
pageFilterstring-Filtert nach dem Pfad der Seite (Freiwillig)
classNamestring-Weitere CSS-Klassen für das Aussehen

Vorteile von der Datenbank:

  • Sie verwalten alle Referenzen an einem zentralen Ort.
  • Sie können über die API suchen und filtern.
  • Sie können die gleichen Quellen für mehrere Artikel nutzen.
  • Das Format der Daten passt zu BibLaTeX.

ReferencesSearch  

Das ist eine Suche für alle Referenzen in der Datenbank. Sie können die Suche direkt auf der Seite bedienen.

Props:

PropTypStandardBeschreibung
lang'de' | 'en''de'Sprache für die Texte der Anzeige
showStatsbooleanfalseZeigt den Bereich für Statistiken an
compactbooleanfalseKleine Ansicht für den Blog
variant'dark' | 'light''dark'Helle oder dunkle Farben
classNamestring-Weitere CSS-Klassen für das Aussehen

Funktionen:

  • Sie können in Beschreibungen und Internetadressen suchen.
  • Sie können die Ergebnisse nach 12 Kategorien filtern.
  • Sie können nach Artikeln oder Seiten filtern.
  • Sie können die Liste sortieren. Das geht nach Nummer, Beschreibung oder Kategorie.
  • Die Ergebnisse sind auf mehrere Seiten aufgeteilt.

Daten in die Datenbank laden  

Manche Teile der Internetseite brauchen eine Datenbank. Sie laden dafür die Quellenangaben in die Datenbank. Die Datenbank heißt PostgreSQL.

Format für die Daten (BibLaTeX-Schema)  

12 Kategorien  

IDNameBeschreibung
officialOffizielle QuellenDokumente von der Regierung oder von Behörden
academicWissenschaftlichTexte von Universitäten oder Forschern
researchForschungSammlungen von Forschungen und Texten von Konferenzen
technicalTechnische TexteTexte mit Anleitungen und Regeln für die Technik
toolProgramme und WerkzeugeComputerprogramme und Orte für Programmcode
commercialUnternehmen und ProdukteInternetseiten von Firmen und Seiten von Produkten
standardsRegeln und VorgabenTechnische Regeln und gute Beispiele aus der Praxis
newsNachrichten und MedienArtikel aus den Nachrichten und Texte für die Presse
blogBlogs und MeinungenPersönliche Internetseiten und Meinungen von Fachleuten
videoVideos und TondateienVideos auf YouTube, Podcasts und Kurse im Internet
communityGemeinschaften und VereineGruppen von Menschen, Vereine und gemeinnützige Firmen
otherAndereAndere Quellen ohne feste Gruppe

Befehle für das Laden in die Datenbank  

Zugriff über die API  

Sie können Quellenangaben auch über eine Schnittstelle abrufen. Diese Schnittstelle heißt REST-API. Sie können damit auch neue Quellenangaben erstellen.


Wann brauchen Sie welche Komponente?  

Wann nutzen Sie das?Komponente
Quellenangabe im TextCitation mit Datenbank-ID
Liste mit Quellen am Ende der SeiteAutomatisch mit ArticleReferencesSection
Eigene Liste mit QuellenAllReferencesFlat mit pageFilter
Suche nach QuellenReferencesSearch
API-Verbindung für andere Programme/api/references

Teil 8: Installation und beste Tipps 

Benötigte Pakete  

Beispiele für Komponenten bei normalen Aufgaben  

Oder als Gitter (CardGrid):

Checkliste vor der Veröffentlichung  

Titel: Der Titel ist klar. Er enthält das wichtigste Suchwort.
Meta-Description: Der Text für Suchmaschinen hat 150 bis 160 Zeichen. Er nennt einen klaren Vorteil.
Einleitung: Der Text nennt das Problem und die Lösung. Dafür nutzen wir 2 bis 3 Sätze.
Struktur: Die Überschriften haben eine gute und logische Reihenfolge.
Bilder: Der Text hat mindestens ein Diagramm oder eine Grafik.
Code-Beispiele: Die Beispiele passen zur Praxis. Alle Beispiele haben Kommentare.
Fazit: Der Text hat eine kurze Zusammenfassung. Der Text sagt dem Leser, was er als Nächstes tun soll.
Gerechte Sprache: Der Text beachtet alle Geschlechter. Das gilt für den ganzen Text.
Stimmung im Text: Wir schreiben sicher und aktiv. Wir haben einen klaren Blick für die Zukunft.

Haben Sie Fragen zur Umsetzung? Schreiben Sie uns eine E-Mail an: office@webconsulting.at

Was ist Leichter Lesen?

A2

Diese Seite ist in Leichter Sprache geschrieben. Leichte Sprache hilft vielen Menschen, Texte besser zu verstehen. Die Sätze sind kurz. Schwierige Wörter werden erklärt.

Dieser Text wurde nach den Regeln der Leichten Sprache erstellt. Textniveau: A2 (Gemeinsamer Europäischer Referenzrahmen).

Lassen Sie uns ueber Ihr Projekt sprechen

Standorte

  • Mattersburg
    Johann Nepomuk Bergerstraße 7/2/14
    7210 Mattersburg, Austria
  • Wien
    Ungargasse 64-66/3/404
    1030 Wien, Austria

Dieser Inhalt wurde teilweise mithilfe von KI erstellt.