Features
doQumentation macht aus IBM Quantum's Open-Source-Inhalt a interaktive Lernplattform mit live Code-Ausführung, Simulator-Modus und Lernfortschritt-Tracking.
Inhaltsbibliothek
381 Seide mit Inhalt
42 Tutorials, 171 Guides, 154 Kurs-Seide, und 14 Module — alles aus IBM Quantum's Open-Source Qiskit-Dokumentation.
Tutorials durchsuache →Auto-Sync vom Upstream
Der Inhalt wrd automatisch vom IBM's GitHub-Repository synchronisiert, so dass Tutorials und Kurse mit de letschde Qiskit-Releases aktuell bleibed.
Strukturierte Navigation
Automatisch generierte Seideleischde mit zuklappbare Kategorie. Tutorials, Guides, Kurse und Module hend jeweils ihre eigene organisierte Seideleischd.
Live Code-Ausführung
Run / Back Toggle
Jede Notebook-Seid hot en Run-Button, der alle Code-Zelle mit eme live Jupyter-Kernel aktiviert. Klick Back fer zruck zur statische Onsicht.
Drei Ausführungs-Backends
Kostenlose Remote-Ausführung über Binder (koi Installation nötig), vollständig offline über Docker, oder selbschd gehostet uf eme RasQberry Pi.
Backend konfiguriere →IBM Cloud Code Engine
Serverless Jupyter kernel on your IBM Cloud account. Cold start in seconds instead of Binder's 10–25 minutes. Free tier covers roughly 14 hours per month.
Set up Code Engine →Open in Google Colab
Every notebook page has an 'Open in Colab' button for zero-install cloud execution. Opens translated notebooks when browsing in another language.
Zell-Ausführungs-Feedback
Visuelles Feedback uf jeder Zelle: bernsteifarbene Rand während dr Ausführung, grün wenn fertig, rot bei Fehler. A Legende erscheint in dr Toolbar wenn dr Kernel bereit isch.
Kontextuelle Fehlerhinweise
Automatische Erkennung vo ModuleNotFoundError, NameError und Kernel-Verbindungsabbruch. Handlungsorientierte Hinweise erscheined unter dr Zelle mit vorgeschlagene Lösunge.
Ein-Klick-Pip-Installation
Wenn a fehlendes Paket erkannt wrd, erscheint a klickbarer 'Install'-Button. Noch dr Installation wrd d'fehlgeschlagene Zelle automatisch neu ausgfiert.
In JupyterLab öffne
Jede Notebook-Seid hot en Button zum Öffne vom vollständige .ipynb in JupyterLab fer erweiterte Bearbeitung und Erkundung.
Run All & Restart
Run All executes every cell in order with a live progress counter. Stop after the current cell anytime. Restart gives you a fresh kernel without losing your Binder session.
IBM Quantum Integration
Credential Store
Speicher dein IBM Quantum API-Token und CRN oimol in de Settings. Wird lokal in deim Browser mit 7-Tage Auto-Ablauf fer Sicherheit gspeichert.
Credentials eirichte →Auto-Injection
Credentials werded still in de Kernel beim Start eingfügt. Koi Notwendigkeit Token in jedes Notebook einzfüge — einfach Run klicke.
Simulator-Modus
Führ alle Notebooks ohne en IBM Quantum Account aus. Wähl AerSimulator fer ideale Simulation, oder such aus Dutzende vo FakeBackends die echde Geräteräusche modelliered. Koi Setup nötig.
Simulator aktiviere →Ausführungs-Modus-Badge
D'Toolbar zeigt a, welcher Modus aktiv isch — dr Simulator-Name (z.B. 'FakeSherbrooke') oder 'IBM Quantum' — so weischt immer wie dein Code läuft.
Lerna & Fortschritt
Fortschritts-Tracking
Seide die du besuchsch krieged en Haken (✓) in dr Seideleischd. Notebooks die du ausfiersch krieged en Abspielsymbol (▶). Verfolg dei Reis durch de Inhalt.
Kategorie-Badges
Jede Seideleischd-Kategorie zeigt a Badge wie '3/10' a, so dass du de Fortschritt uf en Blick sehsch. Klick fer Fortschritt pro Abschnitt z'lösche.
Lesn fortsetze
D'Startseid zeigt a 'Mach do weiter wo du ufghört hosch'-Karte mit deiner letschd besuchde Seid und wann du do warsch.
Zur Startseid →Bookmarks
Star any page to bookmark it. Bookmarks appear on the homepage. Stored locally, up to 50 pages.
View bookmarks →Display Preferences
Adjust code font size (10–22px), toggle static cell outputs, and suppress Python warnings for cleaner output.
Adjust display →Onboarding Tips
First-time visitors see contextual tips — like "Click Run to execute code live" on notebook pages. Tips auto-dismiss after a few visits.
Multi-Language
20 Languages
The full site is available in 20 languages including German, Japanese, Spanish, French, and more. Each locale runs on its own subdomain with translated UI.
Automatic Fallback
Untranslated pages fall back to English with a banner in the reader's language, so no page is ever missing.
Suach, UI & Bereitstellung
Lokale Suach
Volltext-Suach über alle 381 Seide, funktioniert offline. Ergebnisse erscheined sofort während du tippsch.
Dark Mode
Vollständige Unterstützung fer dunkles Theme. Schaltkreis-Diagramme und Matplotlib-Ausgabe werded automatisch invertiert fer bessere Lesbarkeit.
Video-Einbettunge
Kurs-Videos mit YouTube-Mapping fer zuverlässige Wiedergabe. Fällt zruck uf IBM Video wenn YouTube ned verfügbar isch.
Docker Deployment
Multi-Stage Docker-Build mit CI/CD zu GitHub Container Registry. Vollständiger Stack (Seid + Jupyter) oder leichtes Static-Only-Image.
Mobile Responsive
Hamburger-Navigation, horizontales Code-Scrolling und responsive Karten-Grids. Funktioniert uf Smartphones und Tablets.
Mathe-Rendering
KaTeX fer schnelles, hochqualitatives LaTeX-Mathe-Rendering über alle Inhaltsseide — Gleichunge, Matrize und Quanten-Notation.