NextBook

Nextbook est un moyen rapide et facile de guider les livres techniques ou la documentation qui prennent en charge les normes modernes et fonctionnent rapidement. Il fonctionne en compilant Markdown et MDX aux pages statiques. De cette façon, le premier rendu de contenu sur l'appareil de l'utilisateur est presque instantané.

Nextbook rend la rédaction de documents techniques stupides simples tout en gardant des fonctionnalités minimales mais ouvertes pour une extension supplémentaire.

Caractéristiques principales?

• ? Bonne interface utilisateur simple et lisible basée sur TailwindCSS, y compris le mode dark et la disposition auto-centered ,
• ? Grand SEO hors de la boîte,
• Mobile et imprimable,
• Application à page unique avec pré-fourche,
• ? Création de contenu facile avec Markdown et Support MDX,
• Quelque chose de plus que ce que propose le code clôturé de base. Comme la mise en évidence de ligne, liant à la source et la copie dans le presse-papiers,
• ? Foux de travail Git familier et collaboration,
• ⌨︎ raccourcis clavier pour les actions fréquemment utilisées (changement de thème, navigation de page),
• ? Table des matières facultatives en page avec Scroolspy,
• © Vous possédez vos données, le code est les données . S'engager dans le référentiel et voir les résultats dans la forme la plus simple,
• ? Rapide pour commencer, juste une commande pour l'amélioration et l'exécution localement,
• ? Déploiement d'un clic (ou push),
• ? Des fonctionnalités dynamiques illimitées peuvent être ajoutées avec MDX,
• ⚙︎ Base de code personnalisable, extensible et simple,
• ❤ construit sur open source,
• ? Et beaucoup plus de petits détails ...

Avec les avantages de Next.js et réagir quoi que ce soit de fantaisie (classement, commutation de niveau ...) peut être ajouté en cours de route.

Quoi de neuf dans le manuel de Next 3.0?

Cette version contient des améliorations de vitesse majeures et des changements incompatibles en arrière. La plupart d'entre eux proviennent de MDX2 en supprimant certaines fonctionnalités et d'autres anciennes bibliothèques ne prennent toujours pas en charge les modules ES.

• Migré vers next-mdx-remote v.4 qui utilise désormais MDX2 . Cela a des améliorations de vitesse et une vérification de syntaxe MDX plus stricte. Voir mdx2
• Remplacé certains plugins Markdown incompatibles personnalisés par des homologues MDX. Ce sont:
  • Indice: était ~ , est devenu <sub> balise.
  • Exposant: était ^ , devenu <sup> tag.
  • Mark (Higlight): Was == , est devenu <mark> TAG.
  • Syntaxe modifiée pour Accordion et les composants Tabs . Voir la documentation connexe.
• Fonctionnalité supprimée
  • Code en retrait. Ceci a été supprimé de MDX2 . Utilisez d'autres façons de définir les blocs de code clôturés.
  • Liant avec des supports d'angle: ceci a été supprimé de MDX2 . Utilisez d'autres façons de définir des liens.

Quoi de neuf dans le livret 2.0 Next?

• Prise en charge de plusieurs livres dans un seul projet.
• Conception basée sur TailwindCSS.
• Le contenu de Markdown est maintenant chargé de Next-MDX-Remote. Cela signifie que le contenu est désormais séparé des pages routées.
• Disposition auto-centrée sur les grandes résolutions menant à une option de configuration en moins.
• 40% plus petite taille de faisceau.
• Barre de navigation.
• UI mobile raffiné.
• Moins de code (−4 000 loc).

Commencer

1. Ayant un nœud installé au préalable, bootstrap un nouveau projet avec npx create-next-app my-awesome-book -e https://github.com/amiroff/NextBook
2. Exécutez npm run dev:watch et ouvrez http: // localhost: 3000 /
3. Vérifiez la documentation pour voir ce qui est possible avec NEXTBOOK.
4. Créez votre contenu Markdown ou MDX dans le dossier content . Les pages doivent se réprimer automatiquement lorsque vous modifiez le contenu Markdown.
5. Mettez à jour config/config.json avec votre table des matières et autres informations.
6. Mettez à jour pages/index.jsx pour répondre à vos besoins en tant que page de destination autonome ou comme redirection vers le contenu.
7. Déployez votre respector ou export ( npm run export ) et copiez votre contenu dans un fournisseur d'hébergement statique comme Vercel, NetLify, GitHub Pages ou Google Cloud.
8. Amusez-vous! ?

Cela devrait être suffisant pour avoir une page / livre de documentation généré par statistiquement.