NextBook

NextBook ist eine schnelle und einfache Möglichkeit, technische Bücher oder Dokumentationen zu buid, die moderne Standards unterstützen und schnell lauten. Es funktioniert, indem es Markdown und MDX zu statischen Seiten zusammenstellt. Auf diese Weise ist der erste Inhalt auf dem Gerät des Benutzers nahe.

Nextbook macht das Schreiben von technischen Dokumenten einfach einfach und hält Features Minimal minimal, aber für weitere Erweiterungen offen.

Hauptmerkmale?

• ? Gut aussehende, einfache und lesbare Benutzeroberfläche basierend auf Rückenwindcss, einschließlich dark Modus und auto-centered Layout,
• ? Tolle SEO aus der Schachtel,
• Mobile & Druckerfreundlichkeit,
• Einseiten-Anwendung mit Vorabschärfen,
• ? Einfache Erstellung von Inhalten mit Markdown- und MDX -Unterstützung,
• Etwas mehr als das, was grundlegende eingezäunte Code bietet. Wie Zeilen -Hervorhebung, Verknüpfung mit Quelle und Kopieren in Zwischenablage,
• ? Vertrauter Git -Workflow und Zusammenarbeit,
• ⌨︎ Tastaturverknüpfungen für häufig verwendete Aktionen (Themenänderung, Seitennavigation),
• ? Inhaltliche Inhaltsverzeichnis mit Scoolspy,
• © Sie besitzen Ihre Daten, Code sind die Daten . Sich zum Repository verpflichten und Ergebnisse in der einfachsten Form sehen,
• ? Schnell, um loszulegen, nur ein Befehl für Up & Laufen vor Ort,
• ? Ein Klick (oder Push) Bereitstellung,
• ? Unbegrenzte dynamische Funktionen können mit MDX hinzugefügt werden.
• ⚙︎ Anpassbare, erweiterbare und einfache Codebasis,
• ❤ auf Open-Source gebaut,
• ? Und viele weitere kleine Details ...

Mit den Vorteilen von Next.js und reagieren Sie alles.

Was ist neu in Nextbook 3.0?

Diese Veröffentlichung enthält wichtige Geschwindigkeitsverbesserungen und rückwärts inkompatible Änderungen. Die meisten davon stammen von MDX2, die einige Funktionen entfernen und andere alte Bibliotheken immer noch keine ES -Module unterstützen.

• Migriert zu next-mdx-remote v.4 das jetzt MDX2 verwendet. Dies hat einige Geschwindigkeitsverbesserungen und strengere MDX -Syntaxprüfung. Siehe MDX2
• Ersetzt einige benutzerdefinierte inkompatible Markdown -Plugins durch MDX -Gegenstücke. Diese sind:
  • Index: wurde ~ , wurde <sub> Tag.
  • Superscript: Wurde ^ wurde <sup> Tag.
  • Mark (Higlight): war == , wurde <mark> Tag.
  • Syntax für Accordion und Tabs geändert. Siehe verwandte Dokumentation.
• Funktionalität entfernt
  • Eingereiner Code. Dies wurde aus MDX2 entfernt. Verwenden Sie andere Möglichkeiten, um eingezäunte Codeblöcke zu definieren.
  • Verknüpfung mit Winkelklammern: Dies wurde von MDX2 entfernt. Verwenden Sie andere Möglichkeiten, um Links zu definieren.

Was ist neu in Nextbook 2.0?

• Unterstützung für mehrere Bücher in einem Projekt.
• Design basierend auf Rückenwindcss.
• Der Markdown-Inhalt wird jetzt mit Next-MDX-Remote geladen. Dies bedeutet, dass der Inhalt nun von Routed -Seiten getrennt ist.
• Automatisch zentriertes Layout zu großen Auflösungen, die zu einer weniger Konfigurationsoption führen.
• 40% kleinerer Bündelgröße.
• Navigationsleiste.
• Raffinierte mobile Benutzeroberfläche.
• Weniger Code (–4.000 loc).

Erste Schritte

1. Nachdem der Knoten zuvor installiert wurde, starten Sie ein neues Projekt mit npx create-next-app my-awesome-book -e https://github.com/amiroff/NextBook
2. Run npm run dev:watch und Öffnen Sie http: // localhost: 3000/
3. Überprüfen Sie die Dokumentation, um zu sehen, was mit Nextbook möglich ist.
4. Erstellen Sie Ihren Markdown- oder MDX -Inhalt im content . Seiten sollten automatisch neu sind, wenn Sie den Markdown-Inhalt ändern.
5. Aktualisieren Sie config/config.json mit Ihrem Inhaltsverzeichnis und anderen Informationen.
6. Aktualisieren Sie pages/index.jsx um Ihren Anforderungen als eigenständige Zielseite oder als Umleitung für Inhalt zu entsprechen.
7. Bereiten Sie Ihren Respository oder Export ( npm run export ) bereit und kopieren Sie Ihre Inhalte in einen statischen Hosting -Anbieter wie Vercel, Netlify, GitHub -Seiten oder Google Cloud.
8. Viel Spaß! ?

Dies sollte ausreichen, um eine statisch generierte Dokumentationsseite/eine statisch generierte Seite/ein Buch zu haben.