about.md

About

Test relative URL

portal.config.json

{
    "enabled": true,
    "source": null,
    "home": {
        "path": "/home",
        "content_type": "text/html",
        "site_page": true,
        "text_content": "<div class=\"container-xxl\" style=\"margin-top: 30px;\">\n  <h1>Home of this awesome API!</h1>\n  <p>\n    Lorem ipsum dolor sit amet consectetur adipiscing elit. Quisque faucibus ex sapien vitae pellentesque sem placerat. In id cursus mi pretium tellus duis convallis. Tempus leo eu aenean sed diam urna tempor. Pulvinar vivamus fringilla lacus nec metus bibendum egestas. Iaculis massa nisl malesuada lacinia integer nunc posuere. Ut hendrerit semper vel class aptent taciti sociosqu. Ad litora torquent per conubia nostra inceptos himenaeos.\n  </p>\n  <p>\n    Lorem ipsum dolor sit amet consectetur adipiscing elit. Quisque faucibus ex sapien vitae pellentesque sem placerat. In id cursus mi pretium tellus duis convallis. Tempus leo eu aenean sed diam urna tempor. Pulvinar vivamus fringilla lacus nec metus bibendum egestas. Iaculis massa nisl malesuada lacinia integer nunc posuere. Ut hendrerit semper vel class aptent taciti sociosqu. Ad litora torquent per conubia nostra inceptos himenaeos.\n  </p>\n  <a href=\"/foo\">Go to doc !</a>\n</div>"
    },
    "logo": {
        "url": "https://github.com/MAIF/otoroshi/raw/master/resources/otoroshi-logo.png",
        "path": "/favicon.png",
        "content_type": "image/png"
    },
    "references": [
        {
            "title": "Rick & Morty API",
            "link": "/openapi-rm.json",
            "icon": {
                "css_icon_class": "bi bi-rocket"
            }
        },
        {
            "title": "Otoroshi API",
            "link": "/openapi-oto.json"
        }
    ],
    "resources": [
        {
            "title": "Rick & Morty API oas",
            "path": "/openapi-rm.json",
            "content_type": "application/json",
            "url": "https://rickandmorty.zuplo.io/openapi.json"
        },
        {
            "title": "Otoroshi API oas",
            "path": "/openapi-oto.json",
            "content_type": "application/json",
            "url": "https://maif.github.io/otoroshi/manual/code/openapi.json"
        },
        {
            "path": "/documentation/getting-started",
            "content_type": "text/html",
            "site_page": true,
            "text_content": "<div class=\"container-xxl\"><h1>Getting started !</h1></div>"
        },
        {
            "path": "/documentation/more-information",
            "content_type": "text/markdown",
            "site_page": true,
            "transform": "markdown",
            "text_content": "# More information\n\n- Lorem ipsum\n- Lorem ipsum\n\n```json\n{\"foo\":\"bar\"}\n```\n\n"
        },
        {
            "path": "/important/getting-started",
            "content_type": "text/html",
            "site_page": true,
            "text_content": "<div class=\"container-xxl\"><h1>Getting started !</h1></div>"
        },
        {
            "path": "/important/more-information",
            "content_type": "text/markdown",
            "site_page": true,
            "transform": "markdown",
            "url": "../about.md"
        }
    ],
    "navigation": [
        {
            "label": "Documentation",
            "icon": {
                "css_icon_class": "bi bi-journal-text me-2"
            },
            "path": "/documentation",
            "items": [
                {
                    "label": "Information",
                    "kind": "category",
                    "links": [
                        {
                            "label": "Getting started",
                            "link": "/documentation/getting-started",
                            "icon": {
                                "css_icon_class": "bi bi-journal-text me-2"
                            }
                        },
                        {
                            "label": "More information",
                            "link": "/documentation/more-information",
                            "icon": {
                                "css_icon_class": "bi bi-journal-text me-2"
                            }
                        }
                    ]
                },
                {
                    "label": "API",
                    "kind": "category",
                    "links": [
                        {
                            "label": "API Reference",
                            "link": "/api-references",
                            "icon": {
                                "css_icon_class": "bi bi-journal-text me-2"
                            }
                        }
                    ]
                }
            ]
        },
        {
            "label": "Other important stuff",
            "icon": {
                "css_icon_class": "bi bi-exclamation-diamond me-2"
            },
            "path": "/important",
            "items": [
                {
                    "label": "Getting started",
                    "link": "/important/getting-started",
                    "icon": {
                        "css_icon_class": "bi bi-journal-text me-2"
                    }
                },
                {
                    "label": "More information",
                    "link": "/important/more-information",
                    "icon": {
                        "css_icon_class": "bi bi-journal-text me-2"
                    }
                }
            ]
        }
    ],
    "redirections": [
        {
            "from": "/foo",
            "to": "/documentation"
        }
    ],
    "plans": [
        {
            "id": "dev",
            "name": "Dev",
            "description": "An apikey to try the API on prototypes",
            "throttling_quota": 100,
            "daily_quota": 1000,
            "monthly_quota": 1000,
            "tags": [],
            "metadata": {
                "env": "dev"
            }
        }
    ],
    "footer": null,
    "search": {
        "enabled": true
    },
    "banner": null,
    "metadata": {},
    "tags": []
}