Skip to main content

File Uploads & Assets

Great documentation often requires more than just text. Docsio allows you to easily manage and embed various types of assets.

Uploading Files

You can upload files directly through the AI Agent or by using the file manager in the editor. Supported file types include:

  • Images: PNG, JPG, SVG, GIF.
  • Documents: PDF, DOCX.
  • Data: JSON, YAML.

Embedding Images

Once an image is uploaded, you can embed it in your Markdown pages using standard syntax:

![Description of the image](/img/your-image.png)

The AI Agent can also handle this for you: "Upload this screenshot and add it to the 'Installation' page."

Managing Assets

All your uploaded files are stored in the static/ directory of your project. This ensures they are served efficiently via our CDN and are easily accessible within your documentation.

Best Practices

  • Optimize Images: Use compressed formats to ensure fast page loads.
  • Alt Text: Always provide descriptive alt text for images to improve accessibility and SEO.
  • Consistent Naming: Use clear, lowercase filenames with hyphens (e.g., dashboard-screenshot.png).
Docs by Docsio