Skip to content
Last updated

Content

Create and manage all types of content in your Redocly project, from Markdown pages to API documentation and interactive components.

Content types

Project structure

Organize your content with files, folders, and configuration for optimal navigation and maintenance.

Markdown content

Write rich documentation using Markdown syntax, Markdoc tags, code blocks, and interactive elements.

API documentation

Add OpenAPI, AsyncAPI, GraphQL, and SOAP API documentation with interactive features and extensions.

Static assets

Include images, files, and other static resources in your documentation projects.

Enhanced content features

Versioning

Create and manage multiple versions of your documentation with automatic navigation and switching.

Diagrams

Add visual diagrams using Mermaid syntax to illustrate concepts and workflows.

Redirects

Manage URL redirects to maintain links when restructuring your content.

Links

Create and manage internal and external links with automatic validation and checking.

Localization

Translate your content into multiple languages with built-in localization features.

Mock server

Test APIs with automatically generated mock servers based on your OpenAPI specifications.

Interactive components

Markdoc tags

Enhance your content with interactive components like cards, tabs, admonitions, and code groups.

Markdoc functions

Use built-in functions for dynamic content generation and manipulation.

Getting started

  1. Structure your project - Set up your content organization with the project structure guide
  2. Add your content - Start with Markdown pages or API documentation using our enhanced Markdown features
  3. Enhance with components - Use Markdoc tags to add interactive elements like cards, tabs, and code groups
  4. Manage versions - Set up content versioning if needed for your project, and configure navigation for version-specific content

Resources

  • Markdoc tag library - Complete reference of available interactive components like cards, tabs, admonitions, and code groups
  • API documentation features - Add OpenAPI, AsyncAPI, GraphQL, and SOAP API documentation with interactive features and extensions
  • Localization guide - Translate your content into multiple languages with built-in localization features and UI label management
  • Content versioning - Create and manage multiple versions of your documentation with automatic navigation and version switching
 
Next page