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

https://github.com/parseablehq/developer-hub

This is the Parseable documentation repository
https://github.com/parseablehq/developer-hub

Last synced: 5 months ago
JSON representation

This is the Parseable documentation repository

Awesome Lists containing this project

README

          

# Fumadocs Documentation Site

This is a documentation site built with [Fumadocs](https://fumadocs.dev/) and Next.js. Fumadocs is a modern documentation framework that provides a beautiful, responsive, and feature-rich documentation experience.

## Features

- Built on Next.js App Router
- MDX support for rich content
- Built-in search functionality
- Responsive navigation
- Dark/light mode
- Code highlighting

## Getting Started

Run the development server:

```bash
npm run dev
# or
pnpm dev
# or
yarn dev
```

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

## Project Structure

- `lib/source.ts`: Code for content source adapter, [`loader()`](https://fumadocs.dev/docs/headless/source-api) provides the interface to access your content.
- `app/layout.config.tsx`: Shared options for layouts, optional but preferred to keep.

| Route | Description |
| ------------------------- | ------------------------------------------------------ |
| `app/(docs)` | The documentation layout and pages. |
| `app/api/search/route.ts` | The Route Handler for search. |

### Fumadocs MDX

A `source.config.ts` config file has been included, you can customise different options like frontmatter schema.

Read the [Introduction](https://fumadocs.dev/docs/mdx) for further details.

## Learn More

To learn more about Next.js and Fumadocs, take a look at the following
resources:

- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js
features and API.
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
- [Fumadocs](https://fumadocs.vercel.app) - learn about Fumadocs