Skip to main content

Available components​

There are some visual components which should help creating documentation pages.

Route​

Route component is used to generate environment-aware endpoint.

To include Route start by importing the component:

import Route from "@site/src/components/route";

Place the component inside the content of the page.

<Route method="get" permission="public" path="/communities" />

Route supports method attribute with available options: get, post, put, delete
Route supports permission attribute with available options: public, private, protected
Route supports path attribute which should contain path without the endpoint domain.

Table​

There are several predefined tables.

import { Headers, Query, Parameters, Body } from "@site/src/components/table";

Place the component inside the content of the page.

<Query withPagination rows={...} />

<Parameters rows={...} />

<Body rows={...} />

Headers table supports withAuth attribute which would automatically render Autorization-related headers.

Query table supports withPagination attribute which would automatically render Pagination-related query parameters.

Section​

This content is rendered inside

<section></section>

Notes​

To include Route start by importing the component:

import Note from "@site/src/components/note";
note
<Note></Note>
info
<Note info></Note>
tip
<Note tip></Note>
caution
<Note warning></Note>
danger
<Note danger></Note>