mirror of
https://github.com/jamiepine/voicebox.git
synced 2026-09-16 13:20:39 -07:00
Jamie Pine
64dd29d35a
- Created new directory structure for documentation under `/docs2`. - Added `.gitignore` to exclude build artifacts and dependencies. - Introduced `package.json`, `next.config.mjs`, and `postcss.config.mjs` for project configuration. - Implemented MDX components in `mdx-components.tsx` for rendering documentation. - Migrated existing documentation content and created new files for auto-updater and other features. - Established compatibility layer for Mintlify components in `mintlify-compat.tsx`. - Set up OpenAPI documentation in `openapi.json`. - Updated README and migration guide to reflect new structure and usage instructions. - Ensured all components and pages are ready for development and deployment with Fumadocs.
46 lines
1.5 KiB
Markdown
46 lines
1.5 KiB
Markdown
# fumadocs-ui-template
|
|
|
|
This is a Next.js application generated with
|
|
[Create Fumadocs](https://github.com/fuma-nama/fumadocs).
|
|
|
|
Run development server:
|
|
|
|
```bash
|
|
npm run dev
|
|
# or
|
|
pnpm dev
|
|
# or
|
|
yarn dev
|
|
```
|
|
|
|
Open http://localhost:3000 with your browser to see the result.
|
|
|
|
## Explore
|
|
|
|
In the project, you can see:
|
|
|
|
- `lib/source.ts`: Code for content source adapter, [`loader()`](https://fumadocs.dev/docs/headless/source-api) provides the interface to access your content.
|
|
- `lib/layout.shared.tsx`: Shared options for layouts, optional but preferred to keep.
|
|
|
|
| Route | Description |
|
|
| ------------------------- | ------------------------------------------------------ |
|
|
| `app/(home)` | The route group for your landing page and other pages. |
|
|
| `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.dev) - learn about Fumadocs
|