NextBook

Nextbook es una forma rápida y fácil de superar libros técnicos o documentación que respalden los estándares modernos y funcionen rápidamente rápido. Funciona compilando Markdown y MDX a páginas estáticas. De esta manera, el primer contenido renderizado en el dispositivo del usuario es casi instantáneo.

Nextbook hace que escribir documentos técnicos estúpidos estúpidos mientras mantiene los características mínimas pero abiertas para una mayor extensión.

Características principales?

• ? La interfaz de usuario de buena apariencia, simple y legible basada en tallas de las ondas de cola, incluido el modo dark y el diseño auto-centered ,
• ? Gran SEO fuera de la caja,
• Móvil e imprimir,
• Aplicación de una sola página con precisión previa,
• ? Creación de contenido fácil con soporte de Markdown y MDX,
• Algo más que lo que ofrece el código cercado básico. Como resaltar de línea, vincular a la fuente y copiar al portapapeles,
• ? Flujo de trabajo de git familiar y colaboración,
• ⌨︎ Atajos de teclado para acciones de uso frecuente (cambio de tema, navegación de página),
• ? Tabla de contenido opcional en la página con scroolspy,
• © Usted es dueño de sus datos, el código es los datos . Comprometerse con el repositorio y ver resultados en la forma más simple,
• ? Rápido para comenzar, solo un comando para subir y ejecutar localmente,
• ? Un clic (o empujar) implementación,
• ? Se pueden agregar características dinámicas ilimitadas con MDX,
• ⚙︎ Base de código personalizable, extensible y simple,
• ❤ Construido en código abierto,
• ? Y muchos más detalles pequeños ...

Con las ventajas de Next.js y reaccionar cualquier cosa elegante (calificación, cambio de nivel ...) se puede agregar en el camino.

¿Qué hay de nuevo en NextBook 3.0?

Esta versión contiene mejoras de velocidad importantes y cambios incompatibles hacia atrás. La mayoría de estos provienen de MDX2 que elimina alguna funcionalidad y otras bibliotecas antiguas aún no admiten módulos ES.

• Migró a next-mdx-remote v.4 que ahora usa MDX2 . Esto tiene algunas mejoras de velocidad y una verificación de sintaxis MDX más estricta. Ver MDX2
• Reemplazó algunos complementos de markdown incompatibles personalizados con contrapartes MDX. Estos son:
  • Subíndice: fue ~ , se convirtió en <sub> etiqueta.
  • Superscript: fue ^ , se convirtió en <sup> etiqueta.
  • Mark (Higlight): fue == , se convirtió en la etiqueta <mark> .
  • Cambiado de sintaxis para componentes Accordion y Tabs . Ver documentación relacionada.
• Funcionalidad eliminada
  • Código de muesca. Esto fue eliminado de MDX2 . Use otras formas de definir bloques de código cercados.
  • Vinculación con soportes de ángulo: esto se eliminó de MDX2 . Use otras formas de definir enlaces.

¿Qué hay de nuevo en NextBook 2.0?

• Soporte para múltiples libros en un proyecto.
• Diseño basado en Tailwindcss.
• El contenido de Markdown ahora se está cargando con Next-MDX-Remote. Esto significa que el contenido ahora está separado de las páginas enrutadas.
• Diseño centrado en automóviles en grandes resoluciones que conducen a una opción de configuración menos.
• Tamaño de paquete 40% más pequeño.
• Barra de navegación.
• UI móvil refinada.
• Menos código (−4,000 LOC).

Empezando

1. Tener el nodo instalado de antemano, bootstrap un nuevo proyecto con npx create-next-app my-awesome-book -e https://github.com/amiroff/NextBook
2. Ejecutar npm run dev:watch y abre http: // localhost: 3000/
3. Verifique la documentación para ver lo que es posible con NextBook.
4. Cree su contenido Markdown o MDX en la carpeta content . Las páginas deben refrescar automáticamente mientras modifica el contenido de Markdown.
5. Actualice config/config.json con su tabla de contenido y otra información.
6. Actualice pages/index.jsx para satisfacer sus necesidades como una página de destino independiente o como redirección al contenido.
7. Implemente su respositorio o exportación ( npm run export ) y copie su contenido a cualquier proveedor de alojamiento estático como Vercely, NetLify, GitHub Pages o Google Cloud.
8. ¡Divertirse! ?

Esto debería ser suficiente para tener una página/libro de documentación generada por está estática.