Welcome to NextBook!

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 or 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.

Getting Started

  1. Bootstrap a project with npx create-next-app my-awesome-book -e https://github.com/amiroff/NextBook/tree/master/template
  2. Run npm run dev and open http://localhost:3000/
  3. Check examples to see what's possible with NextBook.
  4. Create your markdown or MDX content in pages folder.
  5. Update config/config.json with your table of contents and other information.
  6. Build (npm run build) and deploy your repository to any static hosting provider like Vercel, Netlify, Github Pages or Google Cloud.
  7. Profit! 🎉

This should be enough to have a statically generated documentation page / book.

With the advantages of Next.js, anything fancy (grading, level switching, you name it..) can be added along the way.

Primary Features 🧿

  • 💅 Good looking, simple and readable UI including dark mode, fluid and centered layouts,
  • 🌎 Great SEO out of the box,
  • 📱 Mobile & printer friendly,
  • 🚀 Single page application with pre-fetching,
  • 🧾 Easy content creation with markdown and MDX support,
  • 💻 Something more than what basic fenced code offers. Like line highlighting, linking to source and copying to clipboard,
  • 🤓 Familiar Git workflow and collaboration,
  • ⌨︎ Keyboard shortcuts for frequently used actions (theme change, sidebar toggle, page navigation),
  • 🔎 In-page optional table of contents with scroolspy,
  • © You own your data, code is the data. Committing to repository and seeing results in the simplest form,
  • 🏎 Fast to get started, just one command for up & running locally,
  • 🎊 One click (or push) deployment,
  • 🛠 Unlimited dynamic features can be added with MDX,
  • ⚙︎ Customisable, extensible and simple codebase,
  • ❤ Built on open-source,
  • 👍 And many more small details...

Use Right Tool For The Job
NextBook is not geared towards API documentation, rather it is optimised for tutorial/book style documentation. For API docs ReadTheDocs, Docusaurus or plain Sphinx would be a better fit.

NextBook Features