Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
node_modules
.vitepress/dist
.vitepress/cache
.DS_Store
78 changes: 78 additions & 0 deletions docs/.vitepress/config.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
import { defineConfig } from 'vitepress'

export default defineConfig({
title: 'Studio MCP',
description: 'Turn any CLI command into an MCP tool',

themeConfig: {
logo: '/logo.svg',

nav: [
{ text: 'Guide', link: '/guide/getting-started' },
{ text: 'Reference', link: '/reference/template-syntax' },
{ text: 'Examples', link: '/examples/basic' },
{ text: 'GitHub', link: 'https://github.com/studio-mcp/studio' }
],

sidebar: {
'/guide/': [
{
text: 'Introduction',
items: [
{ text: 'What is Studio MCP?', link: '/guide/what-is-studio' },
{ text: 'Getting Started', link: '/guide/getting-started' },
{ text: 'Installation', link: '/guide/installation' }
]
},
{
text: 'Configuration',
items: [
{ text: 'Claude Desktop', link: '/guide/config-claude' },
{ text: 'Cursor', link: '/guide/config-cursor' },
{ text: 'VSCode', link: '/guide/config-vscode' }
]
},
{
text: 'Advanced',
items: [
{ text: 'Debugging', link: '/guide/debugging' },
{ text: 'Development', link: '/guide/development' }
]
}
],
'/reference/': [
{
text: 'Reference',
items: [
{ text: 'Template Syntax', link: '/reference/template-syntax' },
{ text: 'Command Line Options', link: '/reference/cli-options' },
{ text: 'Architecture', link: '/reference/architecture' }
]
}
],
'/examples/': [
{
text: 'Examples',
items: [
{ text: 'Basic Examples', link: '/examples/basic' },
{ text: 'Common Tools', link: '/examples/common-tools' },
{ text: 'Advanced Use Cases', link: '/examples/advanced' }
]
}
]
},

socialLinks: [
{ icon: 'github', link: 'https://github.com/studio-mcp/studio' }
],

footer: {
message: 'Released under the MIT License.',
copyright: 'Copyright © 2025 Martin Emde'
},

search: {
provider: 'local'
}
}
})
117 changes: 117 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
# Studio MCP Documentation

This directory contains the VitePress documentation site for Studio MCP.

## Getting Started

### Install Dependencies

```bash
cd docs
npm install
```

### Development Server

Run the local development server:

```bash
npm run dev
```

The site will be available at `http://localhost:5173`

### Build for Production

Build the static site:

```bash
npm run build
```

Output will be in `.vitepress/dist/`

### Preview Production Build

Preview the production build locally:

```bash
npm run preview
```

## Documentation Structure

```
docs/
├── .vitepress/
│ └── config.ts # VitePress configuration
├── guide/ # User guides
│ ├── what-is-studio.md
│ ├── getting-started.md
│ ├── installation.md
│ ├── config-claude.md
│ ├── config-cursor.md
│ ├── config-vscode.md
│ ├── debugging.md
│ └── development.md
├── reference/ # API and technical reference
│ ├── template-syntax.md
│ ├── cli-options.md
│ └── architecture.md
├── examples/ # Examples and tutorials
│ ├── basic.md
│ ├── common-tools.md
│ └── advanced.md
└── index.md # Home page
```

## Adding Content

### New Guide Page

1. Create a new `.md` file in the appropriate directory
2. Add frontmatter if needed
3. Update `.vitepress/config.ts` sidebar configuration

### New Example

1. Add example to `examples/` directory
2. Update sidebar in `.vitepress/config.ts`
3. Link from related pages

## Writing Tips

- Use clear, concise language
- Include code examples for every feature
- Add links to related sections
- Test all code examples
- Use proper markdown formatting

## VitePress Features

- **Markdown Extensions**: Enhanced markdown with custom containers
- **Code Blocks**: Syntax highlighting and line numbers
- **Search**: Built-in search functionality
- **Mobile Responsive**: Works on all devices
- **Fast**: Static site generation for performance

## Deployment

The documentation can be deployed to:

- GitHub Pages
- Netlify
- Vercel
- Any static hosting service

Just build the site and deploy the `.vitepress/dist` directory.

## Contributing

When contributing to the documentation:

1. Follow the existing structure
2. Maintain consistent tone and style
3. Test all code examples
4. Check for broken links
5. Preview changes locally before committing
Loading