NextBook is quick and easy way to build technical books or documentation with markdown that run blazingly fast.
MIT License
NextBook is quick and easy way to buid technical books or documentation that support modern standards and run blazingly fast. It works by compiling markdown and MDX to static pages. This way, first content render on user's device is near instant.
NextBook makes writing technical docs stupid simple while keeping featureset minimal but open for further extension.
dark
mode and auto-centered
layout,With the advantages of Next.js and React anything fancy (grading, level switching...) can be added along the way.
This release contains major speed improvements and backwards incompatible changes. Most of these come from MDX2 removing some functionality and other old libraries still not supporting ES modules.
next-mdx-remote v.4
which now uses MDX2
. This has some speed improvements and stricter MDX syntax checking. See MDX2
~
, became <sub>
tag.^
, became <sup>
tag.==
, became <mark>
tag.Accordion
and Tabs
components. See related documentation.MDX2
. Use other ways to define fenced code blocks.MDX2
. Use other ways to define links.npx create-next-app my-awesome-book -e https://github.com/amiroff/NextBook
npm run dev:watch
and open http://localhost:3000/
content
folder. Pages should auto-refresh as you modify markdown content.config/config.json
with your table of contents and other information.pages/index.jsx
to suit your needs as a standalone landing page or as a redirect to content.npm run export
) and copy your content to any static hosting provider like Vercel, Netlify, Github Pages or Google Cloud.This should be enough to have a statically generated documentation page/book.