Skip to content

A Next.js template for creating interactive ebook with React

License

Notifications You must be signed in to change notification settings

0xsunil/nextjs-ebook-template

 
 

Repository files navigation

Next.js course template

This repository contains the source code for a Next.js app you can use to publish an interactive course with React.

Click here to see a demo!

This template was created to be used on my course on React hooks at useEffect.dev.

Features

  • Write lessons using MDX.
  • Create sublessons to organize your course content.
  • Embed source code in several languages.
  • Embed interactive and editable React examples.
  • Use the template as a base, customize it for your needs!

This template uses:

Usage

  1. Clone or fork this repository
  2. Install dependencies: yarn
  3. Run the app: yarn dev
  4. Open http://localhost:3000 and enjoy 😉

The lessons are located in lessons directory.

Because of the current implementation (that you are free to improve), here are the rules the lessons must follow:

  • The files must named with .mdx extension.
  • The header (between ---) must include a title and a type (foreword, lesson, sublesson, or appendix).
  • For sublessons, the parent attribute in the header must refer to a valid lesson, and please don’t create loops 😉
  • The lessons filenames should be all lowercase.
  • The lessons filenames give the order the lessons will be displayed, so I recommend prefixing them with an index number or letter.

Any remark/suggestion/issue?

Please submit an issue (or better, a pull request) if you want to report a problem or suggest an improvement.

But also know that this template is offered free of charge, and I can’t guarantee to fix all problems 🙂.

About

A Next.js template for creating interactive ebook with React

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 92.9%
  • CSS 7.1%