NextBook

NextBook - это быстрый и простой способ купить технические книги или документацию, которые поддерживают современные стандарты и бегубовно быстро. Он работает путем компиляции Markdown и MDX на статические страницы. Таким образом, первое визуализация контента на устройстве пользователя находится ближе к мгновению.

NextBook делает написание технических документов глупыми, сохраняя при этом минимальные функции, но открыт для дальнейшего расширения.

Основные особенности?

• ? Хорошо выглядящий, простой и читаемый пользовательский интерфейс на основе Tailwindcss, включая dark Mode и auto-centered макет,
• ? Отличный SEO из коробки,
• Мобильные и удобные для принтера,
• Одностраничное приложение с предварительным
• ? Легкое создание контента с поддержкой Marckdown и MDX,
• Что -то большее, чем то, что предлагает базовый огороженный код. Как линия, подчеркивание, связь с источником и копирование в буфер обмена,
• ? Знакомый рабочий процесс GIT и сотрудничество,
• ⌨︎ Комплекты клавиатуры для часто используемых действий (изменение темы, навигация страницы),
• ? Необязательное содержание таблицы с Scroolspy,
• © У вас есть свои данные, код - это данные . Приверженность хранилищу и видение результатов в простейшей форме,
• ? Быстро, чтобы начать, только одна команда для работы и запуска локально,
• ? Развертывание одного щелчка (или толчка),
• ? Неограниченные динамические функции могут быть добавлены с MDX,
• ⚙︎ Настраиваемая, расширяемая и простая кодовая база,
• ❤ Построен на открытом исходном коде,
• ? И еще много мелких деталей ...

С преимуществами next.js и реагировать все, что может быть добавлено, можно добавить все причудливое (оценка, переключение уровня ...).

Что нового в Nextbook 3.0?

Этот релиз содержит значительные улучшения скорости и несовместимые задом наперед. Большинство из них поступают из MDX2, удаляя некоторые функциональные возможности, а другие старые библиотеки все еще не поддерживают модули ES.

• Мигрировал в next-mdx-remote v.4 , который теперь использует MDX2 . Это имеет некоторые улучшения скорости и более строгую проверку синтаксиса MDX. Смотрите MDX2
• Заменили несколько пользовательских несовместимых плагинов Markdown на аналоги MDX. Это:
  • Подписк: был ~ , стал <sub> Tag.
  • SuperScript: был ^ , стал тегом <sup> .
  • Марк (Higlight): был == , стал тегом <mark> .
  • Изменен синтаксис для компонентов Accordion и Tabs . См. Связанная документация.
• Удаленная функциональность
  • С отступом код. Это было удалено из MDX2 . Используйте другие способы определения огороженных кодовых блоков.
  • Связывание с угловыми кронштейнами: это было удалено из MDX2 . Используйте другие способы определения ссылок.

Что нового в Nextbook 2.0?

• Поддержка нескольких книг в одном проекте.
• Дизайн на основе Tailwindcss.
• Содержание Markdown теперь загружается в следующем MDX-Remote. Это означает, что контент теперь отделен от маршрутируемых страниц.
• Автоцентрированный макет по большим разрешениям, ведущим к одному варианту конфигурации.
• 40% меньший размер пакета.
• Навигационная планка.
• Изысканный мобильный пользовательский интерфейс.
• Меньше кода (-4000 loc).

Начиная

1. Установка узла заранее, загрузите новый проект с npx create-next-app my-awesome-book -e https://github.com/amiroff/NextBook
2. Запустите npm run dev:watch и откройте http: // localhost: 3000/
3. Проверьте документацию, чтобы увидеть, что возможно с помощью Nextbook.
4. Создайте свой содержимое Markdown или MDX в папке content . Страницы должны автоматически Refresh при изменении контента разметки.
5. Обновите config/config.json с вашим содержанием и другой информацией.
6. Обновить pages/index.jsx в соответствии с вашим потребностями в качестве отдельной целевой страницы или в качестве перенаправления на содержание.
7. Разверните ваш ответ или экспорт ( npm run export ) и скопируйте ваш контент любому статическому хостингу, такому такущему Vercel, NetLify, GitHub Pages или Google Cloud.
8. Веселиться! ?

Этого должно быть достаточно, чтобы иметь статически сгенерированную страницу документации/книгу.