✨ Highlights

Dieses Release führt die semantische Suche als Alpha-Vorschau ein, fügt die automatische robots.txt-Generierung im SEO-Plugin hinzu, behebt das Mermaid C4Context-Rendering und enthält einen neuen Config-Upgrade-Befehl zur Modernisierung bestehender Projekte.

Semantische Suche (Alpha-Vorschau)

docmd unterstützt jetzt semantische Suche basierend auf lokalen Embeddings, die kontextbezogene Suchergebnisse über einfache Schlüsselwortsuche hinaus ermöglicht.

Funktionen

  • Kontextbezogene Suche über exakte Schlüsselwortübereinstimmungen hinaus
  • Natürliche Fehlertoleranz bei Tippfehlern
  • Findet verwandte Inhalte auch bei unterschiedlicher Terminologie
  • Vollständig lokale Verarbeitung ohne externe Dienste oder API-Aufrufe

Aktivieren Sie die semantische Suche, indem Sie semantic: true zu Ihrer Konfiguration hinzufügen:

{
  "plugins": {
    "search": {
      "semantic": true
    }
  }
}

Das Search-Plugin installiert automatisch docmd-search und lädt erforderliche Modelle herunter. Falls dies fehlschlägt, fällt es auf die Schlüsselwortsuche zurück.

Dokumentation - https://docs.docmd.io/plugins/search/#semantic-search-alpha-preview

Hinweis: Dies ist eine Alpha-Vorschau. Mehrsprachige Modelle sind verfügbar, aber umfassendere Tests und Optimierungen sind noch in Arbeit.

Wir freuen uns, docmd-search vorzustellen.

npm install docmd-search

docmd-search ist eine semantische Suchmaschine für Dokumentationsseiten. Sie läuft vollständig im Browser oder CLI, erfordert keine Server oder API-Schlüssel und hält alle Verarbeitung lokal.

Obwohl für docmd entwickelt, kann sie in andere Dokumentationsplattformen, Websites und Webanwendungen integriert werden.

Dies ist eine frühe Alpha-Version und wird sich weiterentwickeln, aber die Grundlage ist bereits gelegt.

GitHub: https://github.com/docmd-io/docmd-search
Dokumentation: https://docs.docmd.io/search/

SEO-Plugin: robots.txt Auto-Generierung

Das SEO-Plugin generiert jetzt automatisch eine robots.txt-Datei während des Build-Prozesses, falls noch keine existiert.

Funktionen

  • Intelligente Standardwerte mit User-agent: * und Allow: /
  • Automatische sitemap-Referenzen wenn config.url konfiguriert ist
  • Optionale AI-Crawler-Kontrollen
  • Bestehende robots.txt-Dateien werden niemals überschrieben
{
  "plugins": {
    "seo": {
      "aiBots": false
    }
  }
}

Standardmäßig sind AI-Crawler erlaubt. Das Setzen von aiBots: false fügt Direktiven für GPTBot, ChatGPT-User, Google-Extended, CCBot und andere unterstützte AI-Crawler hinzu.

Mermaid C4Context Korrektur

C4Context-Diagramme werden jetzt korrekt gerendert anstatt als leere weiße Boxen angezeigt.

Das Problem wurde durch einen fehlenden SVG-Namespace verursacht, der von Mermaid beim Rendern von C4Context-Diagrammen generiert wird. docmd injiziert jetzt automatisch den erforderlichen Namespace vor dem Parsen, wodurch diese Diagramme korrekt gerendert werden.

Danke an @sinsombat für die Korrektur und die begleitende Test-Suite.

Config-Upgrade-Befehl

Ein neues --upgrade-Flag wurde zum docmd migrate-Befehl hinzugefügt.

npx @docmd/core migrate --upgrade

Das Ausführen des Befehls aktualisiert automatisch ältere Konfigurationsdateien auf das moderne Schema.

Die folgenden Legacy-Schlüssel werden automatisch migriert:

Legacy-Schlüssel Moderner Schlüssel
projects workspace.projects
siteTitle title
siteUrl / baseUrl url
srcDir / source src
outputDir out
defaultLocale i18n.default

Bestehende Werte werden während der Migration beibehalten.

TOC-HTML-Entitätsdekodierung

Überschriftentexte mit Sonderzeichen wie <, >, & und intelligenten Anführungszeichen werden jetzt in der Inhaltsverzeichnis-Seitenleiste korrekt angezeigt.

Zunächst wurden diese Zeichen als rohe HTML-Entitäten statt ihrer beabsichtigten Darstellung angezeigt.

Änderungsprotokoll

Neue Funktionen

  1. Alpha-Vorschau-Unterstützung für semantische Suche via docmd-search hinzugefügt.
  2. Automatische robots.txt-Generierung zum SEO-Plugin hinzugefügt.
  3. search.showFilters hinzugefügt, um die Versionsfilterleiste über den Suchergebnissen auszublenden.
  4. search.showConfidence hinzugefügt, um semantische Suchkonfidenz-Prozentwerte anzuzeigen.
  5. Rechtsbündige Metadaten für Suchergebnisse für Versionen und Konfidenz-Badges hinzugefügt.

Fehlerkorrekturen

  1. Mermaid C4Context-Diagramme, die als leere weiße Boxen gerendert wurden, behoben.
  2. Live-Editor-Template-Rendering-Absturz verursacht durch frühzeitigen workspace-Zugriff behoben.
  3. HTML-Entitätsdekodierung im Inhaltsverzeichnis behoben.
  4. Übermäßige Dev-Server-Neuladungen durch doppelte fs.watch-Ereignisse auf macOS behoben.

Verbesserungen

  1. docmd migrate --upgrade für automatisierte Konfigurationsmodernisierung hinzugefügt.
  2. Projekt-Switcher umgestaltet, um mit dem Erscheinungsbild und den Sprachsteuerungen übereinzustimmen.
  3. Konfigurations- und navigation.json-Änderungen lösen jetzt schnelle gezielte Rebuilds statt vollständige Neustarts aus.
  4. Der Dev-Server öffnet jetzt automatisch die Dokumentations-URL im Standardbrowser beim Start.

Danke 💖

Danke an alle Mitwirkenden, Tester und Problem-Reporter, die diesen Release verbessert haben.

Dokumentation: https://docs.docmd.io/
GitHub: https://github.com/docmd-io/docmd

next Übersicht