Docs

Docs is a simple, statically generated site that dynamically renders markdown content and open api specs.

Dependencies

• nextjs
• glob
• gray-matter
• tailwindcss
• vfile
• mdast
• remarkjs
• yarn

Getting Started

1. Install node
2. Install yarn
3. Run yarn install && yarn dev

Adding Content

Docs will automatically populate markdown content placed in the ~/src/content directory. Directory structure is respected in sidebar navigation, directory names cannot have spaces.

Metadata

You can add gray-matter meta data to content.

The current schema supported is:

---
title: ''
---