LICENSE Documentation

1. Project Overview & Quickstart (Redocly/LICENSE) Copy Chapter

LICENSE

Open-source repository Redocly/LICENSE

Repository Details Copy Section

• Repository: Redocly/LICENSE
• Primary Language: Code

Note: High-volume repository documentation is actively indexed and synchronized by YakaAI.

2. Official Technical Reference & Guides (Redocly/website) Copy Chapter

File: README.md Copy Chapter

Redocly website

This repo is the source of the Redocly website (https://redocly.com).

Development Copy Chapter

Prerequisites Copy Section

• Node.js (version specified in .tool-versions)
• npm

Setup Copy Section

1. Install dependencies:

npm install

2. Start the development server:

npm start

Available Scripts Copy Section

• npm start - Start the development server using Redocly CLI preview
• npm run lint:markdown - Lint markdown files
• npm run lint:markdown:fix - Fix markdown linting issues
• npm run link-marketing-pages - Link a local build of @redocly/marketing-pages via yalc
• npm run unlink-marketing-pages - Remove the yalc link and restore the registry version

Project Structure Copy Chapter

.
├── docs/           # Documentation content
├── pages/          # Website pages
├── static/         # Static assets
├── images/         # Image assets
├── blog/           # Blog content
├── learn/          # Learning resources
└── @theme/         # Theme components

Remote content Copy Chapter

The /docs/cli, /docs/realm, and /docs/redoc content are sourced from other repositories using the remote content feature.

docs
├── cli
├── realm
├── redoc

Sidebars Copy Chapter

The sidebars are located in the root of the repo:

• docs-cli.sidebars.yaml
• docs-realm.sidebars.yaml
• etc...

Contributing Copy Chapter

Please ensure your contribution follows our style guidelines:

• Use Prettier for code formatting
• Follow the markdown linting rules defined in .markdownlint.yaml
• Follow the ESLint configuration

License Copy Chapter

This project is proprietary. See the LICENSE file for details.

File: docs/index.md Copy Chapter

seo: title: About Redocly documentation Copy Chapter

Redocly documentation

Welcome to the official Redocly Documentation.
Ready to build something amazing?

{% cards %}
{% card
title="Get started guide"
layout="horizontal"
align="start"
to="/docs/realm/get-started/index.md"
icon="./images/rocket-icon.svg"
iconVariant="filled"
%}
Go live with your docs in minutes using our guided setup
{% /card %}
{% /cards %}

Products Copy Chapter

{% cards columns=2 cardMinWidth=300 %}

{% card
title="Realm"
to="realm/index.md"
icon="./images/home-page/realm-logo.svg"
%}
The synthesis of Redocly's premier tools—Redoc, Revel, and Reef—united into a single, powerful platform.
{% /card %}

{% card
title="Workflows"
to="../docs-legacy/workflows/changelog.md"
icon="images/home-page/redocly-logo.svg"
%}
Legacy products
{% /card %}

{% card
title="VS Code extension"
to="vscode/index.md"
icon="images/home-page/vscode.svg"
%}
Extension that helps you write, validate, and maintain your OpenAPI documents
{% /card %}

{% /cards %}

Open source Copy Chapter

{% cards columns=2 cardMinWidth=300 %}

{% card
title="Redocly CLI"
to="cli"
icon="images/home-page/terminal-icon.svg"
%}
Open source OpenAPI multi-tool to manage, lint, validate and transform your OpenAPI files.
{% /card %}

{% card
title="Redoc Community Edition"
to="redoc"
icon="images/home-page/develop-docs-icon.svg"
%}
A clean and easy way to produce web-ready documentation from an OpenAPI description.
{% /card %}

{% card
title="Respect Community Edition"
to="respect/index.md"
icon="images/respect-icon.png"
%}
A tool to test API sequences described in Arazzo format.
{% /card %}

{% card
title="End user docs"
to="end-user/index.md"
icon="images/user-docs-icon.svg"

%}
Guide to the project's user interface.
{% /card %}

{% /cards %}

Learn Copy Chapter

{% cards columns=2 cardMinWidth=300 %}

{% card
title="Cafe API example"
to="https://github.com/Redocly/cafe-api"
icon="images/home-page/coffee.svg"
%}
Use our example to learn about OpenAPI or try out some new tools.
{% /card %}

{% card
title="Learn OpenAPI"
to="/learn/openapi/learning-openapi.md"
icon="images/home-page/extension-icon.svg"
%}
Resources for learning more about OpenAPI and how to use it.
{% /card %}

{% card
title="Learn Markdoc"
to="/learn/markdoc/index.md"
icon="images/home-page/markdoc-icon.svg"
%}
Next-generation markup resources and detailed tag library.
{% /card %}

{% card
title="API Guidelines builder"
to="../pages/api-governance/index.md"
icon="images/home-page/checklist-icon.svg"
%}
Use our interactive tool to build linting rules for your API.
{% /card %}

{% /cards %}