Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kristofgazso/docs-reworked

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/kristofgazso/docs-reworked
Owner: kristofgazso
Created: 2023-05-07T11:07:35.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2023-05-07T11:09:25.000Z (over 1 year ago)
Last Synced: 2024-10-16T08:49:06.771Z (3 months ago)
Language: TypeScript
Size: 84 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # Full Next.js example

This is a full-featured boilerplate for a creating a documentation website using Markdoc and Next.js.



## Setup

First, clone this repo and install the dependencies required:

```bash

npm install

# or

yarn install

```

Then, run the development server:

```bash

npm run dev

# or

yarn dev

```

Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.

You can start editing the page by modifying `index.md`. The page auto-updates as you edit the file.

## Deploy

The quickest way to deploy your own version of this boilerplate is by deploying it with [Vercel](https://vercel.com) or [Netlify](https://www.netlify.com/) by clicking one of the buttons below.

### Deploy with Vercel

[![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https://github.com/markdoc/next.js-starter)

### Deploy to Netlify

[![Deploy to Netlify](https://www.netlify.com/img/deploy/button.svg)](https://app.netlify.com/start/deploy?repository=https://github.com/markdoc/next.js-starter)