Documentation

This directory contains the following documents that relate to the project:

• configuration:
  • Configuration Modification describes the available component configuration options.
• development:
  • Development Guide describes how to set up a development environment, write, and run tests. It also contains the naming and architecture convention.
• features:
  • Anchors describes internal anchors in the AsyncAPI component.
  • Highlight markdown's code blocks describes how to add custom language configuration for highlight.js used in the component.
• usage:
  • Using in Angular describes how to use the AsyncAPI component in Angular project.
  • Using in Vue describes how to use the AsyncAPI component in Vue project.
  • Using in NextJS describes how to use the AsyncAPI component in NextJS project.
  • Standalone bundle usage describes how to use the Standalone Bundle of AsyncAPI component with ReactDOM package onboard.
  • Web Component usage describes how to use the web-component.