Ein neuer Look für Rubys Dokumentation

Veröffentlicht von Stan Lo am 23. Dez 2025

Nach dem Neugestaltung von ruby-lang.org gibt es weitere Neuigkeiten, um das 30-jährige Jubiläum von Ruby zu feiern: docs.ruby-lang.org hat ein komplett neues Aussehen mit Aliki – dem neuen Standard-Theme von RDoc.

Ein frisches Aussehen für die Ruby-Dokumentation

Ruby war schon immer eine Freude zu schreiben, und jetzt kann das Lesen von Ruby-Dokumentationen dieser Erfahrung entsprechen. Aliki bringt ein modernes, klares Design auf docs.ruby-lang.org und jedes Gem, das Dokumentation mit RDoc v7.0+ generiert.

Hauptmerkmale

• Verbesserte Suche: Berücksichtigung der Groß-/Kleinschreibung, Fuzzy-Suche und Unterstützung für die Suche nach Konstanten
• Dunkelmodus: Berücksichtigt Ihre OS-Präferenzen mit einer manuellen Umschaltoption
• Dreispaltiges Layout: Linke Seitenleiste für die Navigation, Mitte für den Inhalt, rechte Seitenleiste für das Inhaltsverzeichnis
• Verbesserungen bei Codeblöcken: Kopierbuttons für Codeblöcke und C-Syntax-Hervorhebung
• Anpassbarer Footer: Gem-Maintainer können Links zu ihrem Repository, Issue Tracker und anderen Ressourcen hinzufügen

Für Gem-Autoren

Wenn Sie Dokumentation mit RDoc 7.0+ generieren, sehen Ihre Benutzer Aliki automatisch. Sie können Footer-Links anpassen oder in Ihrer .rdoc_options Datei zum Darkfish-Theme zurückwechseln.

Probieren Sie es aus

Sehen Sie das neue Aussehen in Aktion unter docs.ruby-lang.org.

Wenn Sie Probleme finden oder Vorschläge haben, öffnen Sie bitte ein Issue auf GitHub.