NextJS Documentation Template

About

This is a project to assist in developing Project Documentation. It is Markdown based built with NextJS and Tailwind.

You're currently reading the main README.md file.

Built With

  • Next JS

  • React

  • TailwindCSS

Getting Started

To get a local copy up and running follow these simple example steps.

Prerequisites

  • node (v18.17.0+) Download lastest Node.Js

  • npm (9.6.7+)

terminal
npm install npm@latest -g

Installation

Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services.

Clone the repo

terminal
 git clone https://github.com/mountainhokie/nextjs-docs.git

Install NPM packages

terminal
npm install

Usage

To use either copy or download the markdown and add it to your main github repository folder.

Run Development Server

terminal
npm run dev

Contributions

If you have a suggestion that would make this better, please fork the repo and create a pull request.

License

Distributed under the MIT License.

Contact

Justin Brooks - jubrook1@vt.edu

Project Link: https://github.com/mountainhokie/nextjs-docs

Next
start guide