Quarkdown: Markdown-basiertes Werkzeug für dynamische Typografie

Quarkdown ist ein modernes Markdown-basiertes Satzwerkzeug, das die Leistungsfähigkeit von CommonMark und GitHub Flavored Markdown (GFM) erweitert. Es führt Funktionen, Variablen und Standardbibliotheken ein, mit denen Benutzer dynamische Inhalte erstellen können, die leicht interaktive Präsentationen, Webseiten oder druckfertige Bücher generieren.Quarkdown unterstützt schnelle Kompilierung und Echtzeit-Vorschau für Entwickler, Autoren und Designer. Benutzer können mit einer einfachen Markdown-Syntax ein komplexes Layout erstellen, wobei PDF-Ausgabe und benutzerdefinierte Bibliotheken unterstützt werden. Das Projekt ist quelloffen, gut dokumentiert und verfügt über eine aktive Community für Benutzer, die komplexe Dokumente effizient erstellen müssen.

Funktionsliste

• Dynamische InhaltserstellungUnterstützung von Funktionen und Variablen zur Erstellung interaktiver Inhalte, wie z. B. dynamische Begrüßungen oder bedingte Anweisungen.
• Vorschau in Echtzeit: durch -p im Gesang antworten -w um den Inhalt automatisch zu aktualisieren und ihn live in Ihrem Browser anzuzeigen.
• PDF-Ausgabe: Verwendung --pdf kompiliert das Dokument in eine druckfertige PDF-Datei.
• Unterstützung von StandardbibliothekenBietet Funktionen wie Layout-Konstruktion, mathematische Operationen, bedingte Anweisungen und Schleifen.
• benutzerdefinierte FunktionBenutzer können ihre eigenen Funktionen und Variablen definieren, um die Markdown-Funktionalität zu erweitern.
• Kompilierung mehrerer DateienUnterstützung für Projekte mit mehreren Dateien, Angabe der Stammdatei, um das gesamte Projekt zu kompilieren.
• Interaktiver REPL-Modus: durch quarkdown repl Wechseln Sie in den interaktiven Modus, um den Code schnell zu testen.
• Laden externer Bibliotheken: durch -l vielleicht --libs Laden Sie externe Bibliotheken für erweiterte Funktionen.
• Mehrere Rendering-ZieleUnterstützung von HTML und anderen Rendering-Formaten für die flexible Ausgabe von Inhalten.

Hilfe verwenden

Einbauverfahren

Quarkdown ist ein Befehlszeilentool mit einem einfachen Installationsprozess. Nachfolgend finden Sie die detaillierten Schritte:

1. Sicherstellung der UmweltQuarkdown erfordert die Installation von Node.js (die neueste LTS-Version wird empfohlen). ausführen node -v Prüfen Sie, ob Node.js installiert ist.
2. Klon-LagerBesuchen Sie das GitHub-Repository (https://github.com/iamgio/quarkdown) und führen Sie den folgenden Befehl aus, um das Projekt zu klonen:

   git clone https://github.com/iamgio/quarkdown.git
   

3. Installation von Abhängigkeiten: Wechseln Sie in das Projektverzeichnis und führen Sie das Programm aus:

   cd quarkdown
   npm install
   

4. globale InstallationWenn Sie den Befehl Quarkdown global verwenden möchten, führen Sie ihn aus:

   npm install -g .
   

5. Überprüfen der Installation: Lauf quarkdown --version Prüfen Sie, ob die Installation erfolgreich war.

Verwendung

Quarkdown arbeitet von der Befehlszeile aus, und die wichtigsten Befehle sind quarkdown c <file.qmd>Dies ist der erste Schritt im Prozess der Kompilierung einer Markdown-Datei. Im Folgenden werden die wichtigsten Funktionen und der Arbeitsablauf beschrieben:

1. einzelne Dateien kompilieren

Um eine Quarkdown-Datei zu kompilieren (z. B. die example.qmd), laufen:

quarkdown c example.qmd

Die Ausgabedatei wird standardmäßig im Verzeichnis ./output Verzeichnis. Um das Ausgabeverzeichnis anzugeben, verwenden Sie -o::

quarkdown c example.qmd -o ./my-output

2. eine Vorschau in Echtzeit

Quarkdown unterstützt die Echtzeit-Vorschau, die sich für die schnelle Anpassung von Inhalten eignet. Führen Sie den folgenden Befehl aus, um die Vorschau zu starten:

quarkdown c example.qmd -p -w

• -pStarten Sie die Browser-Vorschau und öffnen Sie automatisch den Standardbrowser.
• -wÜberwachen von Dateiänderungen und automatische Neukompilierung.
  Kombination -p -w Sie können den Vorschaueffekt nach dem Speichern sofort aktualisieren, was sich für die dynamische Anpassung von Präsentationen oder Webseiten eignet.

3. die Erzeugung von PDF

Um ein Dokument als PDF zu exportieren, fügen Sie --pdf Parameter:

quarkdown c example.qmd --pdf

Die erzeugten PDF-Dateien werden im Ausgabeverzeichnis gespeichert und eignen sich zum Drucken von Büchern oder zur Weitergabe von Dokumenten. Weitere PDF-Einstellungen finden Sie in der offiziellen Dokumentation (quarkdown.com/docs).

4. interaktives REPL-Modell

Möchten Sie die Quarkdown-Syntax schnell testen? Verwenden Sie den REPL-Modus:

quarkdown repl

In der interaktiven Umgebung können Sie z. B. direkt Quarkdown-Code eingeben:

.function {greet} to from: **Hello, .to** from .from!
.greet {world} from:{iamgio}

Das Ergebnis der Ausgabe ist:Hello, world from iamgio!. Dieser Modus ist zum Lernen und zur Fehlersuche geeignet.

5. die Verwendung von Standardbibliotheken und benutzerdefinierten Funktionen

Quarkdown bietet eine umfangreiche Standardbibliothek mit Unterstützung für Layout, mathematische Operationen und bedingte Anweisungen. Zum Beispiel die Erstellung einer dynamischen Liste:

.for {item} in {apple, banana, orange}:
- .item
.endfor

Die Ausgabe ist:

• Apfel
• Banane
• orange

Der Benutzer kann auch eigene Funktionen definieren. Beispiel:

.function {welcome} name: Welcome, .name, to Quarkdown!
.welcome {Alice}

Ausgabe:Welcome, Alice, to Quarkdown!. Benutzerdefinierte Funktionen können als Bibliotheken zur Wiederverwendung in anderen Projekten gespeichert werden.

6. dokumentenübergreifende Projekte

Für komplexe Projekte unterstützt Quarkdown die Kompilierung mehrerer Dateien. Stellen Sie sicher, dass Sie die Stammdatei angeben (z. B. main.qmd), werden automatisch auch andere Dateien einbezogen:

quarkdown c mock/main.qmd -p

Beispielhafte Projekte mock Enthält eine Vielzahl von visuellen Elementen zum Erlernen der Funktionen von Quarkdown.

7. externe Bibliotheken laden

Wenn Sie eine externe Bibliothek verwenden müssen, geben Sie das Bibliotheksverzeichnis an:

quarkdown c example.qmd -l ./my-libs

Der Standardpfad für die Bibliothek lautet <install dir>/lib/qmd. Benutzer können ihre eigenen Bibliotheken erstellen und gemeinsam nutzen.

8 Einstellungen für das Rendering-Ziel

Quarkdown gibt standardmäßig HTML aus, aber das kann über die Option -r Gibt andere Rendering-Ziele an:

quarkdown c example.qmd -r html

In der offiziellen Dokumentation finden Sie weitere Rendering-Optionen.

Featured Function Bedienung

• dynamischer InhaltDas Hauptmerkmal von Quarkdown ist die Unterstützung von Funktionen und Variablen. Die Benutzer können die .function Definieren Sie Funktionen, die Standardbibliotheksschleifen und bedingte Anweisungen kombinieren, um dynamische Inhalte zu erzeugen. Beispiel für die Verwendung bedingter Anweisungen:

  .if {condition} == true:
  Content displayed if true
  .else:
  Content displayed if false
  .endif
  

• Musterbeispiel: Mit freundlicher Genehmigung von Quarkdown mock Beispielprojekt zur Demonstration visueller Elemente und typografischer Effekte. ausführen quarkdown c mock/main.qmd -p Vollständige Demo anzeigen.
• Beiträge der GemeinschaftBenutzer können sich an der Entwicklung von Funktionen beteiligen, indem sie Issues oder Pull Requests über GitHub einreichen. Referenzen CONTRIBUTING.md Holen Sie sich den Leitfaden.

Weitere Funktionen und eine ausführliche Dokumentation finden Sie unter quarkdown.com/docs.

Anwendungsszenario

1. Technische Dokumentation
   Entwickler können Quarkdown verwenden, um dynamische technische Dokumentation zu schreiben. Generieren Sie komplexe Dokumentation mit bedingter Logik oder Schleifen durch Funktionen und Variablen. Generieren Sie zum Beispiel automatisch Tabellen oder Listen für die API-Dokumentation.
2. Interaktive Präsentationen
   Lehrkräfte oder Dozenten können mit Quarkdown interaktive Diashows erstellen. Kombinieren Sie Echtzeitvorschauen mit schnellen Inhaltsanpassungen für Präsentationen im Klassenzimmer oder auf Konferenzen.
3. Buchausstattung
   Autoren können Markdown-Dateien zu druckfertigen PDF-Büchern zusammenstellen, die sich für das Self-Publishing oder für technische Handbücher eignen.Die PDF-Ausgabe unterstützt eine Vielzahl von Themen.
4. persönlicher Blog
   Blogger können die dynamischen Fähigkeiten von Quarkdown nutzen, um Webseiten zu erstellen, die interaktive Elemente wie dynamische Begrüßungen oder personalisierte Inhalte enthalten.

QA

1. Welche Markdown-Standards werden von Quarkdown unterstützt?
   Quarkdown basiert auf CommonMark und GitHub Flavored Markdown (GFM) und erweitert es um Funktionen, Variablen und Standardbibliotheksmerkmale. Die Standard-Syntax von Markdown ist vollständig kompatibel.
2. Wie kann man Quarkdown-Code debuggen?
   ausnutzen quarkdown repl Gehen Sie in den interaktiven Modus und testen Sie den Code Zeile für Zeile. Fehlermeldungen werden im Terminal angezeigt, so dass Sie das Problem leicht lokalisieren können.
3. Ist Programmiererfahrung erforderlich?
   Nein. Die Syntax von Quarkdown ist einfach, und Benutzer, die mit Markdown vertraut sind, können sich schnell einarbeiten. Standardbibliotheken und -dokumentation bieten angemessene Unterstützung.
4. Wie kann man verschiedene Formate exportieren?
   Die Standardausgabe ist HTML; verwenden Sie die --pdf Andere Rendering-Formate sind verfügbar über -r angegeben werden, siehe Dokumentation für Details.
5. Wie kann ich mich in meiner Gemeinde engagieren?
   Besuchen Sie die GitHub-Repositories, um Issues oder Pull Requests einzureichen. CONTRIBUTING.md Holen Sie sich einen Leitfaden für die Beitragszahlung.