Getting Started

Introduction

Build your Konnect Developer Portal through a customizable, centralized platform.

Konnect Dev Portal

The Konnect Dev Portal enables organizations to present and share API documentation with developers through a customizable, centralized platform. Customizing the Dev Portal helps to create a cohesive, branded experience that engages users and makes API exploration more seamless.

Konnect Dev Portal v3-only

The syntax and components in this documentation is only available on the latest/v3 version of Konnect Dev Portal.

Portal Editor

To learn more about the Portal Editor feature, and the UX for building Pages and Snippets in Konnect Dev Portal, browse the product documentation.

Within Portal Editor, MDC (Markdown Components), a Vue/Nuxt-based framework, is used for creating content. Pre-built components are provided to provide flexible options to highly customize your custom portal-level content.

Resources

Markdown & MDC Syntax

Learn more about the syntax for Markdown and built-in MDC components

Page Layout Locations

The Portal provides layout locations that are fully-customizable with Snippets. Learn more about the page layout locations and how to use them.

Shared props

Many of the available MDC components have shared props across many components. Learn more about these shared props and typical usage.

Components

Konnect Dev Portal provides a range of built-in MDC components to address most needs in creating a highly customized design for projecting your branding and preferred look and feel. Syntax generators are provided on more complex components to make getting started easier.