Veloera

https://docs.veloera.org/
Admin
Veloera provides a documentation starter kit that guides users through setting up, editing, and...
Tokens:5,039
Snippets:41
Trust Score:4.4
Update:1 year ago
Show doc for...
Tokens:
Raw
### Run Mintlify Local Development Server

Source: https://docs.veloera.org/development

Starts a local development server for previewing documentation. Navigate to the docs directory (containing docs.json) and run this command. The preview will be available at http://localhost:3000 by default.

```bash
mintlify dev
```

--------------------------------

### Install Mintlify CLI with npm or yarn

Source: https://docs.veloera.org/development

Installs the Mintlify command-line interface globally using either npm or yarn. This is a prerequisite for running local development servers and other Mintlify commands. Ensure Node.js (version 19+) is installed.

```bash
npm i -g mintlify
```

```bash
yarn global add mintlify
```

--------------------------------

### Troubleshooting: Reinstall Mintlify after Node Version Change

Source: https://docs.veloera.org/development

Provides steps to resolve 'sharp' module loading errors, often related to outdated Node.js versions. This involves removing the current Mintlify installation, upgrading Node.js, and then reinstalling Mintlify.

```bash
npm remove -g mintlify
npm install -g mintlify
```

--------------------------------

### Markdown Text Formatting Examples

Source: https://docs.veloera.org/essentials/markdown

Illustrates the Markdown syntax for applying common text styles such as bold, italic, and strikethrough. It also shows how to combine these styles and use HTML for superscript and subscript text.

```markdown
`**bold**`
`_italic_`
`~strikethrough~`
`**_bold and italic_**`
`<sup>superscript</sup>`
`<sub>subscript</sub>`
```

--------------------------------

### Run Mintlify on a Custom Port

Source: https://docs.veloera.org/development

Starts the Mintlify local development server on a specified port. Replace '3333' with your desired port number. If the specified port is in use, Mintlify will attempt to use the next available port.

```bash
mintlify dev --port 3333
```

--------------------------------

### Markdown Linking Syntax

Source: https://docs.veloera.org/essentials/markdown

Explains how to create hyperlinks in Markdown, including linking to external websites and internal pages using root-relative paths. It also mentions the performance implications of relative links.

```markdown
[link to google](https://google.com)
[link to text](/writing-content/text)
[link to text](../text)
```

--------------------------------

### Update Mintlify CLI to Latest Version

Source: https://docs.veloera.org/development

Updates the Mintlify command-line interface to the latest available version using npm or yarn. This ensures compatibility with the production version of your website and includes the latest features and bug fixes.

```bash
npm i -g mintlify@latest
```

```bash
yarn global upgrade mintlify
```

--------------------------------

### GET /plants

Source: https://docs.veloera.org/api-reference/endpoint/get

Retrieves a list of all plants accessible to the user. Supports pagination via the 'limit' query parameter.

```APIDOC
## GET /plants

### Description
Returns all plants from the system that the user has access to.

### Method
GET

### Endpoint
/plants

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of results to return

#### Request Body
This endpoint does not accept a request body.

### Request Example
```yaml
GET /plants?limit=10
```

### Response
#### Success Response (200)
- **name** (string) - The name of the plant
- **tag** (string) - Tag to specify the type

#### Response Example
```json
{
  "name": "<string>",
  "tag": "<string>"
}
```

#### Error Response (400)
- **error** (integer) - Error code
- **message** (string) - Error message

#### Error Response Example
```json
{
  "error": 123,
  "message": "<string>"
}
```
```

--------------------------------

### Markdown Blockquote Syntax

Source: https://docs.veloera.org/essentials/markdown

Shows the Markdown syntax for creating single-line and multi-line blockquotes using the '>' character. Blockquotes are used to visually set apart quoted text.

```markdown
> Dorothy followed her through many of the beautiful rooms in her castle.

> Dorothy followed her through many of the beautiful rooms in her castle.
>
> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
```

--------------------------------

### Markdown Titles and Subtitles

Source: https://docs.veloera.org/essentials/markdown

Demonstrates the syntax for creating main titles and subtitles using Markdown's '#' characters. These are used for section headers and sub-section headers, respectively, and automatically generate anchors for navigation.

```markdown
## Titles

### Subtitles
```

--------------------------------

### Display Code Blocks with Syntax Highlighting (Java)

Source: https://docs.veloera.org/essentials/code

Shows how to create fenced code blocks with syntax highlighting for Java code. Enclose the code in triple backticks, followed by the language identifier ('java') and an optional filename ('HelloWorld.java'). This improves readability for longer code examples.

```java
class HelloWorld {
    public static void main(String[] args) {
        System.out.println("Hello, World!");
    }
}
```

--------------------------------

### LaTeX Component in Markdown

Source: https://docs.veloera.org/essentials/markdown

Demonstrates the usage of the custom 'Latex' component within Markdown to render mathematical equations using LaTeX syntax. This allows for the inclusion of complex formulas in documentation.

```markdown
<Latex>8 x (vk x H1 - H2) = (0,1)</Latex>
```

--------------------------------

### Importing and Using Reusable Variables

Source: https://docs.veloera.org/essentials/reusable-snippets

This example shows how to import specific variables (myName, myObject) exported from a snippet file. These imported variables can then be used directly within the destination file's content.

```mdx
import { myName, myObject } from '/snippets/path/to/custom-variables.mdx';

Hello, my name is {myName} and I like {myObject.fruit}.
```

--------------------------------

### Validate Documentation Links

Source: https://docs.veloera.org/development

Checks the documentation for any broken or invalid reference links. Running this command helps maintain the integrity of your documentation by identifying and flagging issues with internal and external links.

```bash
mintlify broken-links
```

--------------------------------

### Configure Documentation with docs.json

Source: https://docs.veloera.org/essentials/settings

The docs.json file is used to configure the core settings of your Mintlify documentation site. It allows for complete control over the look and feel. Ensure this file exists in your project root.

```json
{
  "name": "My Docs",
  "logo": "/logo.png",
  "favicon": "/favicon.ico",
  "colors": {
    "primary": "#007bff"
  }
}
```

--------------------------------

### Plant Store Endpoints

Source: https://docs.veloera.org/api-reference/introduction

This section details the API endpoints available for the Plant Store, as defined in the OpenAPI specification.

```APIDOC
## Plant Store Endpoints

### Description

This section details the API endpoints available for the Plant Store, as defined in the OpenAPI specification.

### Method

GET

### Endpoint

/plants

### Parameters

#### Query Parameters

- **species** (string) - Optional - Filter plants by species.

### Request Example

```json
{
  "message": "GET /plants"
}
```

### Response

#### Success Response (200)

- **plants** (array) - A list of plant objects.
  - **id** (string) - The unique identifier for the plant.
  - **name** (string) - The name of the plant.
  - **species** (string) - The species of the plant.

#### Response Example

```json
{
  "plants": [
    {
      "id": "1",
      "name": "Monstera",
      "species": "Monstera deliciosa"
    },
    {
      "id": "2",
      "name": "Snake Plant",
      "species": "Sansevieria trifasciata"
    }
  ]
}
```
```

--------------------------------

### POST /plants

Source: https://docs.veloera.org/api-reference/endpoint/create

Creates a new plant in the store by sending plant details in the request body.

```APIDOC
## POST /plants

### Description
Creates a new plant in the store.

### Method
POST

### Endpoint
http://sandbox.mintlify.com/plants

### Parameters
#### Query Parameters
None

#### Request Body
- **name** (string) - Required - The name of the plant
- **tag** (string) - Required - Tag to specify the type
- **id** (integer) - Required - Identification number of the plant

### Request Example
```json
{
  "name": "<string>",
  "tag": "<string>",
  "id": 123
}
```

### Response
#### Success Response (200)
- **name** (string) - The name of the plant
- **tag** (string) - Tag to specify the type

#### Response Example
```json
{
  "name": "<string>",
  "tag": "<string>"
}
```

#### Error Response (400)
- **error** (integer) - Error code
- **message** (string) - Error message

#### Error Response Example
```json
{
  "error": 123,
  "message": "<string>"
}
```
```

--------------------------------

### Importing and Using a Reusable Component Snippet

Source: https://docs.veloera.org/essentials/reusable-snippets

This code demonstrates importing a custom component ('MyComponent') from a snippet file and using it with props. The 'title' prop is passed to customize the component's output.

```mdx
import { MyComponent } from '/snippets/custom-component.mdx';

Lorem ipsum dolor sit amet.

<MyComponent title={'Custom title'} />
```

--------------------------------

### Navigation with Folder Structure in JSON

Source: https://docs.veloera.org/essentials/navigation

Shows how to configure navigation when MDX files are organized into folders. The `pages` array references the folder and file name to create the correct link.

```json
"navigation": {
    "tabs": [
      {
        "tab": "Docs",
        "groups": [
          {
            "group": "Group Name",
            "pages": ["your-folder/your-page"]
          }
        ]
      }
    ]
  }
```

--------------------------------

### Regular Navigation Syntax in JSON

Source: https://docs.veloera.org/essentials/navigation

Defines a standard navigation structure with tabs, groups, and pages. This is the basic format for linking documents in the website's navigation menu.

```json
"navigation": {
    "tabs": [
      {
        "tab": "Docs",
        "groups": [
          {
            "group": "Getting Started",
            "pages": ["quickstart"]
          }
        ]
      }
    ]
  }
```

--------------------------------

### Navigation and Appearance Configuration

Source: https://docs.veloera.org/essentials/settings

Customize the appearance and navigation of the project, including top anchors, tabs, and footer social links.

```APIDOC
## Navigation and Appearance Configuration

### Description
Customize the appearance and navigation of the project, including top anchors, tabs, and footer social links.

### Method
N/A (Configuration object)

### Endpoint
N/A

### Parameters
#### Request Body
- **topAnchor** (Object) - Optional - Overrides for the top-most anchor.
  - **name** (string) - Optional - The name of the top-most anchor.
  - **icon** (string) - Optional - Font Awesome icon for the anchor.
  - **iconType** (string) - Optional - Type of icon (e.g., "duotone", "solid").
- **tabs** (Array<Object>) - Optional - An array of navigational tabs.
  - **name** (string) - Required - The name of the tab label.
  - **url** (string) - Required - The URL prefix for pages in this tab.
- **footerSocials** (Object) - Optional - Social media links for the footer.
  - **[key]** (string) - Required - Platform name (e.g., "website", "github").
  - **property** (string) - Required - The URL to the social platform.
```

--------------------------------

### Plant Webhook OpenAPI Specification

Source: https://docs.veloera.org/api-reference/endpoint/webhook

This OpenAPI specification defines a POST webhook endpoint '/plant/webhook' for adding new plants. It details the request body schema, including plant name, tag, and ID, and specifies a 200 response for successful data reception. The endpoint is hosted on sandbox.mintlify.com.

```yaml
WEBHOOK /plant/webhook
paths:
  path: /plant/webhook
  method: post
  servers:
    - url: http://sandbox.mintlify.com
  request:
    security: []
    parameters:
      path: {}
      query: {}
      header: {}
      cookie: {}
    body:
      application/json:
        schemaArray:
          - type: object
            properties:
              name:
                allOf:
                  - description: The name of the plant
                    type: string
              tag:
                allOf:
                  - description: Tag to specify the type
                    type: string
              id:
                allOf:
                  - description: Identification number of the plant
                    type: integer
                    format: int64
            refIdentifier: '#/components/schemas/Plant'
            requiredProperties:
              - name
              - id
        examples:
          example:
            value:
              name: <string>
              tag: <string>
              id: 123
        description: Plant added to the store
  response:
    '200':
      _mintlify/placeholder:
        schemaArray:
          - type: any
            description: >-
              Return a 200 status to indicate that the data was received
              successfully
        examples: {}
        description: >-
          Return a 200 status to indicate that the data was received
          successfully
  deprecated: false
  type: webhook
components:
  schemas: {}
```

--------------------------------

### Importing Simple Content Snippet

Source: https://docs.veloera.org/essentials/reusable-snippets

This snippet demonstrates how to import a basic content snippet into a destination file. The imported content, defined in 'my-snippet.mdx', can include variables like 'word' which can be passed as props during import.

```mdx
import MySnippet from '/snippets/path/to/my-snippet.mdx';

## Header

Lorem impsum dolor sit amet.

<MySnippet word="bananas" />
```

--------------------------------

### Feedback Configuration

Source: https://docs.veloera.org/essentials/settings

Configure options for user feedback mechanisms.

```APIDOC
## Feedback Configuration

### Description
Configure options for user feedback mechanisms.

### Method
N/A (Configuration object)

### Endpoint
N/A

### Parameters
#### Request Body
- **feedback** (Object) - Optional - Feedback configuration settings.
  - **suggestEdit** (boolean) - Optional - Enables a button for users to suggest edits via pull requests.
  - **raiseIssue** (boolean) - Optional - Enables a button for users to raise issues.
```

--------------------------------

### API Configuration

Source: https://docs.veloera.org/essentials/settings

Configure settings for API endpoints, including base URLs, authentication, and playground behavior.

```APIDOC
## API Configuration

### Description
Configure settings for API endpoints, including base URLs, authentication, and playground behavior.

### Method
N/A (Configuration object)

### Endpoint
N/A

### Parameters
#### Request Body
- **baseUrl** (string | string[]) - Optional - The base URL for all API endpoints. Can be an array for multiple options.
- **auth** (Object) - Optional - Authentication settings.
  - **method** (string: "bearer" | "basic" | "key") - Required - The authentication strategy.
  - **name** (string) - Required - The name of the authentication parameter (e.g., "username:password" for basic auth).
  - **inputPrefix** (string) - Optional - A default prefix for the authentication input field.
- **playground** (Object) - Optional - Settings for the API playground.
  - **mode** (string: "show" | "simple" | "hide") - Optional - Determines the playground's visibility and interactivity.
- **maintainOrder** (boolean) - Optional - Ensures OpenAPI key ordering matches the file (will be default soon).
- **openapi** (string | string[]) - Optional - URL(s) or relative path(s) to OpenAPI file(s).
```

--------------------------------

### POST /plant/webhook

Source: https://docs.veloera.org/api-reference/endpoint/webhook

This endpoint is a webhook used to add new plants to the store. It accepts plant details in the request body and returns a success status upon receipt.

```APIDOC
## POST /plant/webhook

### Description
This endpoint is a webhook used to add new plants to the store. It accepts plant details in the request body and returns a success status upon receipt.

### Method
POST

### Endpoint
/plant/webhook

### Parameters
#### Request Body
- **name** (string) - Required - The name of the plant
- **tag** (string) - Optional - Tag to specify the type
- **id** (integer) - Required - Identification number of the plant

### Request Example
```json
{
  "name": "<string>",
  "tag": "<string>",
  "id": 123
}
```

### Response
#### Success Response (200)
- **any** - Return a 200 status to indicate that the data was received successfully

#### Response Example
```json
{
  "message": "Plant added successfully"
}
```
```

--------------------------------

### Embed Image using Markdown

Source: https://docs.veloera.org/essentials/images

Adds an image to your content using standard Markdown syntax. Ensure the image file size is under 5MB, or host it externally and use the URL.

```markdown
![title](/path/image.jpg)
```

--------------------------------

### Nested Navigation Structure in JSON

Source: https://docs.veloera.org/essentials/navigation

Illustrates how to create nested navigation groups within the `docs.json` file. This allows for hierarchical organization of pages, improving menu clarity.

```json
"navigation": {
    "tabs": [
      {
        "tab": "Docs",
        "groups": [
          {
            "group": "Getting Started",
            "pages": [
              "quickstart",
              {
                "group": "Nested Reference Pages",
                "pages": ["nested-reference-page"]
              }
            ]
          }
        ]
      }
    ]
  }
```

--------------------------------

### Display Inline Code in Markdown

Source: https://docs.veloera.org/essentials/code

Demonstrates how to render text as inline code using single backticks. This is useful for short code snippets or technical terms within a sentence. No external dependencies are required, as this is a standard Markdown feature.

```markdown
To denote a `word` or `phrase` as code, enclose it in backticks (`).
```

--------------------------------

### Defining a Simple Content Snippet

Source: https://docs.veloera.org/essentials/reusable-snippets

This code defines a reusable content snippet named 'my-snippet.mdx'. It contains static text and a placeholder for a variable 'word', which can be customized when the snippet is imported and used elsewhere.

```mdx
Hello world! This is my content I want to reuse across pages. My keyword of the
day is {word}.
```

--------------------------------

### API Authentication - Bearer Token Specification

Source: https://docs.veloera.org/api-reference/introduction

This JSON snippet illustrates the configuration for API endpoint authentication using Bearer tokens within an OpenAPI specification. It defines the security scheme to be used by the API.

```json
{
  "security": [
    {
      "bearerAuth": []
    }
  ]
}
```

--------------------------------

### Configure OpenAPI File Paths

Source: https://docs.veloera.org/essentials/settings

Specifies the URL(s) or relative path(s) to your OpenAPI file. This can be a single string or an array of strings for multiple OpenAPI definitions.

```json
"openapi": "https://example.com/openapi.json"
```

```json
"openapi": "/openapi.json"
```

```json
"openapi": ["https://example.com/openapi1.json", "/openapi2.json", "/openapi3.json"]
```

--------------------------------

### Define Footer Social Media Links

Source: https://docs.veloera.org/essentials/settings

An object where keys represent social media platforms and values are the corresponding account URLs. Supported platforms include website, facebook, x, discord, slack, github, linkedin, instagram, and hacker-news.

```json
{
  "x": "https://x.com/mintlify",
  "website": "https://mintlify.com"
}
```

--------------------------------

### Configure Dark Mode Toggle (JSON)

Source: https://docs.veloera.org/essentials/settings

This configuration snippet allows customization of the dark mode toggle. You can set a default mode (light or dark) or hide the toggle entirely. When `isHidden` is true and `default` is set, the documentation will be forced into the specified mode, overriding user OS preferences.

```json
{
  "modeToggle": {
    "default": "dark",
    "isHidden": true
  }
}
```

```json
{
  "modeToggle": {
    "default": "light",
    "isHidden": true
  }
}
```

--------------------------------

### Defining a Reusable Component Snippet

Source: https://docs.veloera.org/essentials/reusable-snippets

This snippet defines a reusable React component ('MyComponent') as an arrow function that accepts props. It renders an H1 tag with the 'title' prop and a paragraph with static snippet content. MDX syntax is not supported within the component's body; HTML syntax should be used.

```mdx
export const MyComponent = ({ title }) => (
  <div>
    <h1>{title}</h1>
    <p>... snippet content ...</p>
  </div>
);
```

--------------------------------

### Exporting Variables from a Snippet

Source: https://docs.veloera.org/essentials/reusable-snippets

This snippet defines and exports two variables: 'myName' (a string) and 'myObject' (an object). These exports allow other files to import and utilize these specific values.

```mdx
export const myName = 'my name';

export const myObject = { fruit: 'strawberries' };
```

--------------------------------

### Embed Generic HTML Page using iframe

Source: https://docs.veloera.org/essentials/images

Embeds an external HTML page within your document using an iframe tag. This is versatile for embedding various web content.

```html
<iframe src="https://www.youtube.com/embed/4KzFe50RQkQ"> </iframe>
```

--------------------------------

### Embed Image using HTML

Source: https://docs.veloera.org/essentials/images

Embeds an image with custom height using an HTML img tag. This offers more control over image display compared to Markdown.

```html
<img height="200" src="/path/image.jpg" />
```

--------------------------------

### DELETE /plants/{id}

Source: https://docs.veloera.org/api-reference/endpoint/delete

Deletes a single plant based on the ID supplied. Requires authentication via Bearer token.

```APIDOC
## DELETE /plants/{id}

### Description
Deletes a single plant based on the ID supplied.

### Method
DELETE

### Endpoint
`/plants/{id}`

### Parameters
#### Path Parameters
- **id** (integer) - Required - ID of plant to delete

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{}
```

### Response
#### Success Response (204)
No Content

#### Error Response (400)
- **error** (integer) - Error code
- **message** (string) - Error message

#### Response Example (400)
```json
{
  "error": 123,
  "message": "<string>"
}
```
```

--------------------------------

### Delete Plant API Endpoint (YAML)

Source: https://docs.veloera.org/api-reference/endpoint/delete

Defines the OpenAPI specification for the DELETE /plants/{id} endpoint. This includes the request method, path, server URL, security requirements (bearer token authentication), request parameters (plant ID), and possible responses (204 for success, 400 for errors).

```yaml
DELETE /plants/{id}
paths:
  path: /plants/{id}
  method: delete
  servers:
    - url: http://sandbox.mintlify.com
  request:
    security:
      - title: bearerAuth
        parameters:
          query: {}
          header:
            Authorization:
              type: http
              scheme: bearer
          cookie: {}
    parameters:
      path:
        id:
          schema:
            - type: integer
              required: true
              description: ID of plant to delete
      query: {}
      header: {}
      cookie: {}
    body: {}
  response:
    '204': {}
    '400':
      application/json:
        schemaArray:
          - type: object
            properties:
              error:
                allOf:
                  - type: integer
                    format: int32
              message:
                allOf:
                  - type: string
            refIdentifier: '#/components/schemas/Error'
            requiredProperties:
              - error
              - message
        examples:
          example:
            value:
              error: 123
              message: <string>
        description: unexpected error
  deprecated: false
  type: path
components:
  schemas: {}
```

--------------------------------

### Embed YouTube Video using HTML

Source: https://docs.veloera.org/essentials/images

Embeds a YouTube video player within your content using an iframe. This is a common method for including video content.

```html
<iframe width="560" height="315" src="https://www.youtube.com/embed/4KzFe50RQkQ" title="YouTube video player" frameBorder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowFullScreen style="width: 100%; border-radius: 0.5rem"> </iframe>
```
Tokens:
Raw