NextBook

O NextBook é uma maneira rápida e fácil de comprar livros técnicos ou documentação que suportam padrões modernos e correm de maneira arborizada. Funciona compilando o Markdown e o MDX em páginas estáticas. Dessa forma, a primeira renderização de conteúdo no dispositivo do usuário está quase instantânea.

O NextBook torna a redação documentos técnicos estúpidos simples, mantendo o Recursost Minimal, mas aberto para uma extensão adicional.

Recursos principais?

• ? UI de boa aparência, simples e legível com base em Tailwindcss, incluindo modo dark e layout auto-centered ,
• ? Ótimo SEO fora da caixa,
• Mobile e amigável para impressoras,
• Aplicativo de página única com pré-busca,
• ? Criação de conteúdo fácil com suporte de Markdown e MDX,
• Algo mais do que o que o código cercado básico oferece. Como o destaque da linha, vinculando -se à fonte e copiando para a área de transferência,
• ? Fluxo de trabalho e colaboração familiares familiares,
• ⌨︎ Atalhos de teclado para ações usadas frequentemente (mudança de tema, navegação por página),
• ? Índice opcional na página com scroolspy,
• © Você possui seus dados, o código são os dados . Comprometer -se com o repositório e ver resultados na forma mais simples,
• ? Rápido para começar, apenas um comando para subir e correr localmente,
• ? Um clique (ou empurrar) implantação,
• ? Recursos dinâmicos ilimitados podem ser adicionados ao MDX,
• ⚙︎ CodeBase de código personalizável, extensível e simples,
• ❤ construído em código aberto,
• ? E muitos outros pequenos detalhes ...

Com as vantagens do Next.js e reaja qualquer coisa extravagante (classificação, troca de nível ...) pode ser adicionada ao longo do caminho.

O que há de novo no Nextbook 3.0?

Esta versão contém grandes melhorias de velocidade e alterações incompatíveis para trás. A maioria deles vem do MDX2 removendo algumas funcionalidades e outras bibliotecas antigas ainda não suportam módulos ES.

• Migrou para o next-mdx-remote v.4 , que agora usa MDX2 . Isso tem algumas melhorias de velocidade e verificação mais rigorosa da sintaxe do MDX. Veja Mdx2
• Substituiu alguns plug -ins de marcação incompatíveis personalizados por contrapartes MDX. Estes são:
  • Subscrito: Was ~ , tornou -se tag <sub> .
  • Superscript: foi ^ , tornou -se <sup> .
  • Mark (higlight): foi == , tornou -se <mark> tag.
  • Sintaxe alterada para componentes Accordion e Tabs . Veja documentação relacionada.
• Funcionalidade removida
  • Código recuado. Isso foi removido do MDX2 . Use outras maneiras de definir blocos de código cercado.
  • Vinculando com suportes de ângulo: isso foi removido do MDX2 . Use outras maneiras de definir links.

O que há de novo no Nextbook 2.0?

• Suporte para vários livros em um projeto.
• Design baseado em Tailwindcss.
• O conteúdo de marcação agora está sendo carregado com o Next-MDX-Remote. Isso significa que o conteúdo agora está separado das páginas roteadas.
• Layout centrado automaticamente sobre grandes resoluções, levando a uma opção de configuração a menos.
• 40% de tamanho de pacote menor.
• Barra de navegação.
• UI móvel refinada.
• Menos código (-4.000 loc).

Começando

1. Tendo o nó instalado com antecedência, bootstrap um novo projeto com npx create-next-app my-awesome-book -e https://github.com/amiroff/NextBook
2. Run npm run dev:watch e abra http: // localhost: 3000/
3. Verifique a documentação para ver o que é possível no Nextbook.
4. Crie seu conteúdo de marcação ou MDX na pasta de content . As páginas devem refrescar automaticamente à medida que você modifica o conteúdo de marcação.
5. Atualize config/config.json com o índice e outras informações.
6. Atualize pages/index.jsx para atender às suas necessidades como uma página de destino independente ou como um redirecionamento para o conteúdo.
7. Implante seu repositório ou exportação ( npm run export ) e copie seu conteúdo para qualquer provedor de hospedagem estática como Vercel, Netlify, Github Pages ou Google Cloud.
8. Divirta-se! ?

Isso deve ser suficiente para ter uma página/livro de documentação gerada estaticamente.