Skip to content

Jake-Short/nextjs-docs-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ee4f2eb · Jul 31, 2020

History

32 Commits
Jul 30, 2020
Jul 30, 2020
Jul 30, 2020
Jul 30, 2020
Jul 31, 2020
Jul 30, 2020
Jul 31, 2020
Jul 25, 2020
Jul 30, 2020
Jul 30, 2020
Jul 30, 2020
Jul 30, 2020
Jul 30, 2020
Jul 30, 2020
Jul 30, 2020
Jul 30, 2020

Repository files navigation

Documentation Generator using Next.js

License: MIT Maintenance PRs Welcome

Create beautiful documentation quickly, and output an optimized Next.js site. Create and edit markdown files and get a beautiful Next.js site in seconds.

Features

  • Web-based markdown editor with instant results
  • Simple and elegant interface
  • Advanced customizability and styling
  • Powerful Next.js site
  • Easy deployment

Live Demo

To view an example site built using this project, visit this project's documentation!

Getting Started

First, clone this repository.

git clone https://github.com/Jake-Short/nextjs-docs-generator.git

Then, CD into the directory, install NPM modules, and run the development server.

cd nextjs-docs-generator

yarn

yarn dev

Open http://localhost:3000 with your browser to see the result.

The site will show some documentation to get you started:

Documentation

You can visit the documentation site at http://nextjs-docs-generator.vercel.app. Alternatively, a brief version of the documentation is shown when you clone and run the site.

Learn More About Next.js

To learn more about Next.js, you can view these resources:

You can also check out the Next.js GitHub repository