API Console LWC

API Documentation tool built using LWC.

Getting started

npm install @mulesoft/api-console-lwc

We ship our components ready for both platform and non-platform usage. Below you can find guides to using the components in each scenario.

Salesforce DX project

You can find the Salesforce-ready components under the node_modules/@mulesoft/api-console-lwc/dist/arc folder.

We recommend the following to take into consideration:

• Ignore test files
• Add the appropriate -meta.xml files for your project's use case
• Import the markdown component manually*

*This component should be imported manually because the markdown component imports a library (showdown), which needs to be loaded before rendering.

Regular Node usage

You should be able to import the bundle script with

import '@mulesoft/api-console-lwc`

Running this script will register the components to the browser's registry, and allow you to to render them like normal web components in your project.

Contributing

Take a look at our Contributing Guidelines.

How to start?

Start simple by running npm start. This will start the project with a local development server.

The source files are located in the src folder. All web components are within the src/arc folder. The folder hierarchy also represents the naming structure of the web components. The files for running the local demo can be found in the src/demo folder.