Welcome to your new Specra documentation site! This project was created with create-specra.
First, install dependencies and run the development server:
npm install
npm run dev
# or
yarn install
yarn dev
# or
pnpm install
pnpm devOpen http://localhost:3000 with your browser to see your documentation site.
├── app/ # Next.js app directory
│ ├── layout.tsx # Root layout
│ ├── page.tsx # Home page
│ └── docs/ # Documentation pages
├── components/ # Reusable components
│ ├── docs/ # Documentation-specific components
│ └── ui/ # UI components
├── docs/ # Your MDX documentation files
│ └── v1.0.0/ # Version 1.0.0 docs
├── lib/ # Utility functions
│ ├── mdx.ts # MDX processing
│ ├── config.ts # Configuration
│ └── parsers/ # API parsers
├── public/ # Static assets
└── specra.config.json # Specra configuration
Add your MDX files in the docs/v1.0.0/ directory:
---
title: My Page
description: This is my documentation page
---
# My Page
Your content here...Import and use components in your MDX:
import { Callout } from '@/components/docs/callout'
import { CodeBlock } from '@/components/docs/code-block'
import { Tabs, Tab } from '@/components/docs/tabs'
<Callout type="info">
This is an info callout!
</Callout>
<Tabs>
<Tab title="JavaScript">
```js
console.log('Hello World')
```
</Tab>
<Tab title="TypeScript">
```ts
console.log('Hello World')
```
</Tab>
</Tabs>Edit specra.config.json to customize your site:
{
"site": {
"title": "Your Docs",
"description": "Your documentation site",
"url": "https://yourdocs.com"
},
"navigation": {
"links": [
{ "title": "Home", "href": "/" },
{ "title": "Docs", "href": "/docs" }
]
}
}npm run build
npm run startDeploy your Specra documentation site to Vercel, Netlify, or any hosting platform that supports Next.js.
- Check the documentation
- Report issues on GitHub