Porffor

https://porffor.mintlify.app/
Admin
Porffor is a project with comprehensive API documentation and developer guides built on Mintlify,...
Tokens:7,094
Snippets:125
Trust Score:6.8
Update:5 months ago
Show doc for...
Tokens:
Raw
### Install Mintlify CLI (yarn)

Source: https://porffor.mintlify.app/development

Installs the Mintlify command-line interface globally using yarn. Ensure Node.js version 19 or higher is installed.

```bash
yarn global add mintlify
```

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

### Install Mintlify CLI

Source: https://porffor.mintlify.app/quickstart

Install the Mintlify CLI globally to preview documentation changes locally. This command is run in your terminal.

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

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

### Start Local Development Server

Source: https://porffor.mintlify.app/quickstart

Run this command at the root of your documentation repository to preview changes locally. Ensure docs.json is present.

```bash
mintlify dev
```

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

### Get Plants

Source: https://porffor.mintlify.app/api-reference/endpoint/get

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

```APIDOC
## GET /plants

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

### Method
GET

### Endpoint
/plants

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

#### Success Response (200)
- **Plant** (array) - A list of plants.

#### Response Example
{
  "example": "[\n  {\n    \"name\": \"string\",\n    \"tag\": \"string\"\n  }\n]"
}

#### Error Response (400)
- **Error** - An error object.

#### Response Example
{
  "example": "{\n  \"error\": 0,\n  \"message\": \"string\"\n}"
}
```

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

### Start Local Development Server on Custom Port

Source: https://porffor.mintlify.app/development

Runs the Mintlify development server on a specified port, overriding the default port 3000. Use the --port flag.

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

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

### Example of a Code Block within Markdown

Source: https://porffor.mintlify.app/essentials/code

This example shows how a Java code block is rendered within a Markdown document, including the language identifier and filename.

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

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

### Troubleshooting: Reinstall Mintlify

Source: https://porffor.mintlify.app/development

Reinstall Mintlify globally after removing the current version. This is a troubleshooting step for potential installation issues.

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

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

### OpenAPI Specification for GET /plants

Source: https://porffor.mintlify.app/api-reference/endpoint/get

This OpenAPI 3.1.0 specification defines the GET /plants endpoint. It includes details on the server URL, security schemes, request parameters (like 'limit'), and possible responses (200 for success, 400 for errors), along with schema definitions for Plant and Error objects.

```yaml
GET /plants
openapi: 3.1.0
info:
  title: OpenAPI Plant Store
  description: >-
    A sample API that uses a plant store as an example to demonstrate features
    in the OpenAPI specification
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: http://sandbox.mintlify.com
security:
  - bearerAuth: []
paths:
  /plants:
    get:
      description: Returns all plants from the system that the user has access to
      parameters:
        - name: limit
          in: query
          description: The maximum number of results to return
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: Plant response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Plant'
        '400':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Plant:
      required:
        - name
      type: object
      properties:
        name:
          description: The name of the plant
          type: string
        tag:
          description: Tag to specify the type
          type: string
    Error:
      required:
        - error
        - message
      type: object
      properties:
        error:
          type: integer
          format: int32
        message:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

```

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

### Markdown Link to Internal Page (Root-Relative)

Source: https://porffor.mintlify.app/essentials/markdown

Link to pages within your documentation using root-relative paths, starting with a '/'.

```markdown
[link to text](/writing-content/text)
```

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

### Markdown Multiline Blockquote

Source: https://porffor.mintlify.app/essentials/markdown

Create multiline blockquotes by using the greater-than symbol at the start of each line, including blank lines for separation.

```markdown
> 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.
```

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

### Update Mintlify CLI and Upgrade Configuration

Source: https://porffor.mintlify.app/quickstart

If using the legacy mint.json, update the Mintlify CLI to the latest version and run the upgrade command to migrate to docs.json.

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

```bash
mintlify upgrade
```

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

### Create a Basic MDX Snippet

Source: https://porffor.mintlify.app/essentials/reusable-snippets

Define reusable content in an MDX file within the `snippets` directory. This content can include variables passed via props.

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

```

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

### Import and Use a Basic MDX Snippet

Source: https://porffor.mintlify.app/essentials/reusable-snippets

Import a custom snippet into another MDX file and render it, optionally passing props to customize its content.

```mdx
---
title: My title
description: My Description
---

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

## Header

Lorem impsum dolor sit amet.

<MySnippet word="bananas" />

```

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

### Add Image using Markdown

Source: https://porffor.mintlify.app/essentials/images

Use Markdown syntax to include images. Ensure image file size is under 5MB or host externally.

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

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

### Validate Documentation Links

Source: https://porffor.mintlify.app/development

Checks your documentation for broken reference links. Run this command in your project directory.

```bash
mintlify broken-links
```

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

### Create Plant

Source: https://porffor.mintlify.app/api-reference/endpoint/create

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

```APIDOC
## POST /plants

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

### Method
POST

### Endpoint
/plants

### Request Body
- **Plant to add to the store** (object) - Required
  - **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": 0
}
```

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

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

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

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

### Import and Use a Reusable Component Snippet

Source: https://porffor.mintlify.app/essentials/reusable-snippets

Import a custom component from an MDX snippet file and render it in your destination file, passing necessary props.

```mdx
---
title: My title
description: My Description
---

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

Lorem ipsum dolor sit amet.

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

```

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

### Configure Dark Mode Toggle

Source: https://porffor.mintlify.app/essentials/settings

Use `modeToggle` to customize the dark mode toggle. Set `default` to 'dark' or 'light' to force a specific mode for new users. Use `isHidden` to hide the toggle entirely.

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

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

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

### Create a Code Block with Syntax Highlighting

Source: https://porffor.mintlify.app/essentials/code

Use fenced code blocks by enclosing code in three backticks. Specify the programming language after the leading ticks for syntax highlighting. Optionally, include a filename.

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

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

### Navigation with Folder Structure

Source: https://porffor.mintlify.app/essentials/navigation

Configures navigation to include pages organized within folders. The path in `docs.json` should reflect the folder structure, e.g., `your-folder/your-page`.

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

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

### Configure OpenAPI File Path

Source: https://porffor.mintlify.app/essentials/settings

Specify the URL or relative path to your OpenAPI file. Supports a single file or an array for multiple options.

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

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

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

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

### Update Mintlify CLI to Latest Version (npm)

Source: https://porffor.mintlify.app/development

Updates the Mintlify CLI to the latest available version using npm. This ensures you have the most recent features and bug fixes.

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

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

### Add Image using Embeds

Source: https://porffor.mintlify.app/essentials/images

Utilize embed syntax for more customizable image integration. This allows for attributes like height.

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

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

### Update Mintlify CLI to Latest Version (yarn)

Source: https://porffor.mintlify.app/development

Updates the Mintlify CLI to the latest available version using yarn. This ensures you have the most recent features and bug fixes.

```bash
yarn global upgrade mintlify
```

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

### Nested Navigation Structure

Source: https://porffor.mintlify.app/essentials/navigation

Illustrates how to create nested navigation groups for more complex site hierarchies. This allows for deeper organization within the navigation menu.

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

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

### Regular Navigation Structure

Source: https://porffor.mintlify.app/essentials/navigation

Defines a basic navigation structure with tabs and groups. Use this for simple site layouts.

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

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

### Create Plant OpenAPI Specification

Source: https://porffor.mintlify.app/api-reference/endpoint/create

This OpenAPI 3.1.0 specification defines the POST /plants endpoint for creating a new plant. It includes schemas for the request body (NewPlant) and responses (Plant, Error).

```yaml
POST /plants
openapi: 3.1.0
info:
  title: OpenAPI Plant Store
  description: >-
    A sample API that uses a plant store as an example to demonstrate features
    in the OpenAPI specification
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: http://sandbox.mintlify.com
security:
  - bearerAuth: []
paths:
  /plants:
    post:
      description: Creates a new plant in the store
      requestBody:
        description: Plant to add to the store
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/NewPlant'
        required: true
      responses:
        '200':
          description: plant response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Plant'
        '400':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    NewPlant:
      allOf:
        - $ref: '#/components/schemas/Plant'
        - required:
            - id
          type: object
          properties:
            id:
              description: Identification number of the plant
              type: integer
              format: int64
    Plant:
      required:
        - name
      type: object
      properties:
        name:
          description: The name of the plant
          type: string
        tag:
          description: Tag to specify the type
          type: string
    Error:
      required:
        - error
        - message
      type: object
      properties:
        error:
          type: integer
          format: int32
        message:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

```

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

### Import and Use Exported Variables

Source: https://porffor.mintlify.app/essentials/reusable-snippets

Import variables exported from a snippet file into your destination file and use them within your content.

```mdx
---
title: My title
description: My Description
---

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

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

```

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

### Create a Reusable MDX Component Snippet

Source: https://porffor.mintlify.app/essentials/reusable-snippets

Define a reusable component within an MDX snippet file by exporting an arrow function that accepts props. Use HTML syntax within the component for compatibility.

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

```

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

### Markdown Link to External URL

Source: https://porffor.mintlify.app/essentials/markdown

Create links to external websites using square brackets for the text and parentheses for the URL.

```markdown
[link to google](https://google.com)
```

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

### Markdown Link to Internal Page (Relative)

Source: https://porffor.mintlify.app/essentials/markdown

Relative links using '../' can be used but may impact optimization.

```markdown
[link to text](../text)
```

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

### Display Inline Code

Source: https://porffor.mintlify.app/essentials/code

Use backticks (`) to denote inline code. This is useful for short code snippets or variable names.

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

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

### OpenAPI Specification for Plant Webhook

Source: https://porffor.mintlify.app/api-reference/endpoint/webhook

This OpenAPI 3.1.0 specification defines the WEBHOOK /plant/webhook endpoint for the Plant Store API. It includes server details, security schemes, and basic API information.

```yaml
WEBHOOK /plant/webhook
openapi: 3.1.0
info:
  title: OpenAPI Plant Store
  description: >-
    A sample API that uses a plant store as an example to demonstrate features
    in the OpenAPI specification
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: http://sandbox.mintlify.com
security:
  - bearerAuth: []
paths: {}
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

```

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

### Configure Footer Social Links

Source: https://porffor.mintlify.app/essentials/settings

Define social media links to be displayed in the footer. Keys represent platforms and values are their respective URLs.

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

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

### Webhook Endpoint

Source: https://porffor.mintlify.app/api-reference/endpoint/webhook

This section describes the webhook endpoint for receiving new plant information.

```APIDOC
## WEBHOOK /plant/webhook

### Description
Information about a new plant added to the store.

### Method
WEBHOOK

### Endpoint
/plant/webhook
```

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

### Export Variables from a Snippet

Source: https://porffor.mintlify.app/essentials/reusable-snippets

Export variables from an MDX snippet file to make them available for import and use in other files.

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

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

```

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

### Markdown Subtitle

Source: https://porffor.mintlify.app/essentials/markdown

Use triple hash symbols for subsection headers in markdown.

```markdown
### Subtitles
```

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

### Markdown Strikethrough Text

Source: https://porffor.mintlify.app/essentials/markdown

Format text with a strikethrough using double tildes.

```markdown
~strikethrough~
```

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

### OpenAPI Specification for Delete Plant

Source: https://porffor.mintlify.app/api-reference/endpoint/delete

This OpenAPI 3.1.0 specification defines the DELETE /plants/{id} endpoint for deleting a plant. It includes request parameters, response codes (204 for success, 400 for errors), and schema definitions.

```yaml
DELETE /plants/{id}
openapi: 3.1.0
info:
  title: OpenAPI Plant Store
  description: >-
    A sample API that uses a plant store as an example to demonstrate features
    in the OpenAPI specification
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: http://sandbox.mintlify.com
security:
  - bearerAuth: []
paths:
  /plants/{id}:
    delete:
      description: Deletes a single plant based on the ID supplied
      parameters:
        - name: id
          in: path
          description: ID of plant to delete
          required: true
          schema:
            type: integer
            format: int64
      responses:
        '204':
          description: Plant deleted
          content: {}
        '400':
          description: unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Error:
      required:
        - error
        - message
      type: object
      properties:
        error:
          type: integer
          format: int32
        message:
          type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer

```

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

### Markdown Singleline Blockquote

Source: https://porffor.mintlify.app/essentials/markdown

Create a blockquote by prefixing a paragraph with a greater-than symbol.

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

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

### Markdown Bold and Italic Text

Source: https://porffor.mintlify.app/essentials/markdown

Combine bold and italic formatting using double asterisks and single underscores.

```markdown
**_bold and italic_**
```

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

### Markdown LaTeX Component

Source: https://porffor.mintlify.app/essentials/markdown

Embed LaTeX mathematical expressions using the `<Latex>` component.

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

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

### HTML Superscript Text

Source: https://porffor.mintlify.app/essentials/markdown

Use the `<sup>` HTML tag for superscript text.

```html
<sup>superscript</sup>
```

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

### Markdown Title

Source: https://porffor.mintlify.app/essentials/markdown

Use double hash symbols for section titles in markdown.

```markdown
## Titles
```

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

### Markdown Bold Text

Source: https://porffor.mintlify.app/essentials/markdown

Format text as bold using double asterisks.

```markdown
**bold**
```

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

### Markdown Italic Text

Source: https://porffor.mintlify.app/essentials/markdown

Format text as italic using single underscores.

```markdown
_italic_
```

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

### Embed YouTube Video using iFrame

Source: https://porffor.mintlify.app/essentials/images

Embed external videos, commonly YouTube, using the iframe HTML tag. This provides a standard way to display video content.

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

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

### OpenAPI Security Specification

Source: https://porffor.mintlify.app/api-reference/introduction

This JSON snippet defines the security scheme for API endpoints using Bearer tokens, as typically found in an OpenAPI specification file.

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

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

### Delete Plant

Source: https://porffor.mintlify.app/api-reference/endpoint/delete

Deletes a single plant based on the ID supplied.

```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

### Response
#### Success Response (204)
Plant deleted

#### Error Response (400)
unexpected error
```

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

### HTML Subscript Text

Source: https://porffor.mintlify.app/essentials/markdown

Use the `<sub>` HTML tag for subscript text.

```html
<sub>subscript</sub>
```
Tokens:
Raw