> ## Documentation Index
> Fetch the complete documentation index at: https://docs.logictwelve.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Configuration

> Configure Stoplight Elements for Confluence

There's no site-wide settings screen. Each macro is configured individually, the first time you insert it on a page and any time afterward you choose to edit it.

## Stoplight Elements macro

Renders any OpenAPI document. Choose **Stoplight document type** first — it determines whether you provide a URL or paste the document directly, and only the matching field is required.

| Field                        | Required              | Notes                                                                                                        |
| ---------------------------- | --------------------- | ------------------------------------------------------------------------------------------------------------ |
| **Stoplight document type**  | —                     | **URL** or **Document**. Default: URL                                                                        |
| **API Description URL**      | When type is URL      | Must start with `http://` or `https://`. Supports documents that use `$ref` to other http(s) documents       |
| **API Description Document** | When type is Document | The OpenAPI document as a YAML string, JSON string, or JavaScript object                                     |
| **Base Path**                | No                    | Helps when **Router** is `history` but the page lives in a subdirectory, e.g. `https://example.com/docs/api` |
| **Try It CORS Proxy**        | No                    | URL of a CORS proxy, prepended to outgoing **Try It** requests                                               |
| **Try It Credential Policy** | No                    | `omit` (default), `include`, or `same-origin` — used for **Try It** fetch calls                              |
| **Layout**                   | No                    | `sidebar` (default) or `stacked` — controls the column design                                                |
| **Router**                   | No                    | `history` (default), `hash`, `memory`, or `static` — controls how in-page navigation works                   |
| **Filter**                   | No                    | **Hide Internal** — filter out content marked `x-internal`. **Hide Try It** — hide the Try It console        |

With **Stoplight document type** set to **URL**, the form shows the **API Description URL** field:

<Frame>
  <img src="https://mintcdn.com/logictwelve-a6acb4a5/ri-T8bkJTW8gw2zt/stoplight-confluence/images/macro-config-elements-url.png?fit=max&auto=format&n=ri-T8bkJTW8gw2zt&q=85&s=3843768423c1a2e50fcb2cb6bea25d28" alt="Stoplight Elements macro configuration form with document type set to URL" width="1170" height="1670" data-path="stoplight-confluence/images/macro-config-elements-url.png" />
</Frame>

With it set to **Document**, the **API Description URL** field is replaced by the **API Description Document** text area:

<Frame>
  <img src="https://mintcdn.com/logictwelve-a6acb4a5/ri-T8bkJTW8gw2zt/stoplight-confluence/images/macro-config-elements-document.png?fit=max&auto=format&n=ri-T8bkJTW8gw2zt&q=85&s=42eca5a02d62078543cb93351172f56e" alt="Stoplight Elements macro configuration form with document type set to Document" width="1170" height="1670" data-path="stoplight-confluence/images/macro-config-elements-document.png" />
</Frame>

## Stoplight Elements Dev Portal macro

Renders a full project hosted on Stoplight's platform. Requires a paid plan on [stoplight.io](https://stoplight.io).

| Field                        | Required | Notes                                                                                                                                                                                                                                                   |
| ---------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Project ID**               | Yes      | Found on the Project Settings screen in Stoplight                                                                                                                                                                                                       |
| **Platform URL**             | Yes      | Defaults to `https://stoplight.io/` — most people can leave this as is; some enterprise customers need to change it                                                                                                                                     |
| **Base Path**                | No       | Same purpose as the Elements macro's Base Path                                                                                                                                                                                                          |
| **Try It CORS Proxy**        | No       | Same purpose as the Elements macro's CORS Proxy                                                                                                                                                                                                         |
| **Try It Credential Policy** | No       | `omit` (default), `include`, or `same-origin`                                                                                                                                                                                                           |
| **Router**                   | No       | `hash` (default), `history`, `memory`, or `static`                                                                                                                                                                                                      |
| **Filter**                   | No       | **Collapse Table Of Contents** — stop the table of contents auto-expanding folders and endpoint lists, useful for large projects. **Hide Mocking** — disable mocking options and remove mock server mentions. **Hide Try It** — hide the Try It console |

The full config form for the Dev Portal macro:

<Frame>
  <img src="https://mintcdn.com/logictwelve-a6acb4a5/ri-T8bkJTW8gw2zt/stoplight-confluence/images/macro-config-dev-portal.png?fit=max&auto=format&n=ri-T8bkJTW8gw2zt&q=85&s=10760e589d9f16dfd55b45ddbb33e25c" alt="Stoplight Elements Dev Portal macro configuration form" width="1170" height="1634" data-path="stoplight-confluence/images/macro-config-dev-portal.png" />
</Frame>

## Permissions

Anyone with edit access to a Confluence page can insert the macro and change its configuration. Page viewers without edit access only see the rendered output.
