Files & Snippets

Vellocs automatically serves static assets from your documentation repository at the appropriate path on your domain. For example, if you have /images/my-logo.png in your repo, the image file is available at https://docs.your-project.com/images/my-logo.png.

You can make any supported file type available to your users, including OpenAPI specifications, images, videos, and more.

Files must be less than 20 MB for images and 100 MB for other file types.

Supported file types

Image formats

• .jpeg, .jpg, .jfif, .pjpeg, .pjp
• .png
• .svg, .svgz
• .ico
• .webp
• .gif, .apng
• .avif
• .bmp
• .tiff, .tif

Video formats

• .mp4
• .webm
• .ogg
• .avi
• .mov
• .wmv
• .flv
• .mkv
• .m4v

Audio formats

• .mp3
• .wav
• .flac
• .aac
• .ogg
• .wma
• .m4a

Font formats

• .woff
• .woff2
• .ttf
• .otf
• .eot

Document formats

• .pdf
• .txt
• .doc, .docx
• .xls, .xlsx
• .ppt, .pptx
• .rtf
• .odt, .ods, .odp

Data formats

• .csv
• .tsv
• .xml

Archive formats

• .zip
• .rar
• .7z
• .tar
• .gz
• .bz2

File organization

Organize your files using folders to keep your repository easy to navigate:

Files are served from the root of your domain, so the structure in your repository directly maps to the URL structure. For example, assets/whitepaper.pdf would be available at https://docs.example.com/assets/whitepaper.pdf.

Snippets

Snippets are reusable MDX content blocks that you can include across multiple documentation pages. They're perfect for content that appears in multiple places, like API authentication instructions, common warnings, or shared code examples.

Creating snippets

Create snippet files in the docs/snippets/ directory. Snippets are regular MDX files without frontmatter:

docs/
└── snippets/
    ├── api/
    │   └── auth-header.mdx
    └── example.mdx

A snippet file contains just the content you want to reuse:

<Alert type="info">
All API requests require authentication via the `Authorization` header.
</Alert>

```bash
Authorization: Bearer YOUR_API_KEY
```

You can find your API key in the [Dashboard Settings](/settings).

Using snippets

Import snippets into any documentation page using the <Snippet> component. Reference files without the .mdx extension:

## Authentication

<Snippet file="api/auth-header" />

## Making your first request

Now that you're authenticated, let's make a request...

Example

Here's the auth-header snippet rendered:

Authorization: Bearer YOUR_API_KEY

You can find your API key in the Dashboard Settings.

Best practices

• Keep snippets focused - Each snippet should contain a single piece of reusable content
• Organize with folders - Use subdirectories like snippets/api/ or snippets/common/ to organize related snippets
• Use descriptive names - Name snippets based on what they contain, like auth-header.mdx or rate-limits.mdx
• Avoid frontmatter - Snippets don't need title or description frontmatter since they're embedded in other pages