# Welcome to your Holiday Shopping Answers Hub
Source: https://help.rarent.com/Holiday-Shopping
RAR operates at full global capacity during the holiday season. This page collects the essentials so your deliveries, rentals, and returns stay effortless.
Directly from MyRAR
Directly from MyRAR
Find below
Find below
## Returns
During the holiday season, we believe you should focus on family, and not on keeping track of all deliveries and returns. Enjoy the break, we've got the returns covered.
Returns for all returnable items have been extended to the 26th of February 2026, or 75 days after the order, whichever is later.
## Delivery
During the holiday season, orders become warm, shining gifts that bring us closer. To ensure they get delivered on time, make sure you order on time.
Order by the 20th of December 2025 to get your order in time for the holidays.
## Gift Wrapping
Choose gift wrapping at checkout and choose from 10 styles of festive paper.
# Claude Code setup
Source: https://help.rarent.com/ai-tools/claude-code
Configure Claude Code for your documentation workflow
Claude Code is Anthropic's official CLI tool. This guide will help you set up Claude Code to help you write and maintain your documentation.
## Prerequisites
* Active Claude subscription (Pro, Max, or API access)
## Setup
1. Install Claude Code globally:
```bash theme={null}
npm install -g @anthropic-ai/claude-code
```
2. Navigate to your docs directory.
3. (Optional) Add the `CLAUDE.md` file below to your project.
4. Run `claude` to start.
## Create `CLAUDE.md`
Create a `CLAUDE.md` file at the root of your documentation repository to train Claude Code on your specific documentation standards:
```markdown theme={null}
# Mintlify documentation
## Working relationship
- You can push back on ideas-this can lead to better documentation. Cite sources and explain your reasoning when you do so
- ALWAYS ask for clarification rather than making assumptions
- NEVER lie, guess, or make up information
## Project context
- Format: MDX files with YAML frontmatter
- Config: docs.json for navigation, theme, settings
- Components: Mintlify components
## Content strategy
- Document just enough for user success - not too much, not too little
- Prioritize accuracy and usability of information
- Make content evergreen when possible
- Search for existing information before adding new content. Avoid duplication unless it is done for a strategic reason
- Check existing patterns for consistency
- Start by making the smallest reasonable changes
## Frontmatter requirements for pages
- title: Clear, descriptive page title
- description: Concise summary for SEO/navigation
## Writing standards
- Second-person voice ("you")
- Prerequisites at start of procedural content
- Test all code examples before publishing
- Match style and formatting of existing pages
- Include both basic and advanced use cases
- Language tags on all code blocks
- Alt text on all images
- Relative paths for internal links
## Git workflow
- NEVER use --no-verify when committing
- Ask how to handle uncommitted changes before starting
- Create a new branch when no clear branch exists for changes
- Commit frequently throughout development
- NEVER skip or disable pre-commit hooks
## Do not
- Skip frontmatter on any MDX file
- Use absolute URLs for internal links
- Include untested code examples
- Make assumptions - always ask for clarification
```
# Cursor setup
Source: https://help.rarent.com/ai-tools/cursor
Configure Cursor for your documentation workflow
Use Cursor to help write and maintain your documentation. This guide shows how to configure Cursor for better results on technical writing tasks and using Mintlify components.
## Prerequisites
* Cursor editor installed
* Access to your documentation repository
## Project rules
Create project rules that all team members can use. In your documentation repository root:
```bash theme={null}
mkdir -p .cursor
```
Create `.cursor/rules.md`:
````markdown theme={null}
# Mintlify technical writing rule
You are an AI writing assistant specialized in creating exceptional technical documentation using Mintlify components and following industry-leading technical writing practices.
## Core writing principles
### Language and style requirements
- Use clear, direct language appropriate for technical audiences
- Write in second person ("you") for instructions and procedures
- Use active voice over passive voice
- Employ present tense for current states, future tense for outcomes
- Avoid jargon unless necessary and define terms when first used
- Maintain consistent terminology throughout all documentation
- Keep sentences concise while providing necessary context
- Use parallel structure in lists, headings, and procedures
### Content organization standards
- Lead with the most important information (inverted pyramid structure)
- Use progressive disclosure: basic concepts before advanced ones
- Break complex procedures into numbered steps
- Include prerequisites and context before instructions
- Provide expected outcomes for each major step
- Use descriptive, keyword-rich headings for navigation and SEO
- Group related information logically with clear section breaks
### User-centered approach
- Focus on user goals and outcomes rather than system features
- Anticipate common questions and address them proactively
- Include troubleshooting for likely failure points
- Write for scannability with clear headings, lists, and white space
- Include verification steps to confirm success
## Mintlify component reference
### Callout components
#### Note - Additional helpful information
Supplementary information that supports the main content without interrupting flow
#### Tip - Best practices and pro tips
Expert advice, shortcuts, or best practices that enhance user success
#### Warning - Important cautions
Critical information about potential issues, breaking changes, or destructive actions
#### Info - Neutral contextual information
Background information, context, or neutral announcements
#### Check - Success confirmations
Positive confirmations, successful completions, or achievement indicators
### Code components
#### Single code block
Example of a single code block:
```javascript config.js
const apiConfig = {
baseURL: 'https://api.example.com',
timeout: 5000,
headers: {
'Authorization': `Bearer ${process.env.API_TOKEN}`
}
};
```
#### Code group with multiple languages
Example of a code group:
```javascript Node.js
const response = await fetch('/api/endpoint', {
headers: { Authorization: `Bearer ${apiKey}` }
});
```
```python Python
import requests
response = requests.get('/api/endpoint',
headers={'Authorization': f'Bearer {api_key}'})
```
```curl cURL
curl -X GET '/api/endpoint' \
-H 'Authorization: Bearer YOUR_API_KEY'
```
#### Request/response examples
Example of request/response documentation:
```bash cURL
curl -X POST 'https://api.example.com/users' \
-H 'Content-Type: application/json' \
-d '{"name": "John Doe", "email": "john@example.com"}'
```
```json Success
{
"id": "user_123",
"name": "John Doe",
"email": "john@example.com",
"created_at": "2024-01-15T10:30:00Z"
}
```
### Structural components
#### Steps for procedures
Example of step-by-step instructions:
Run `npm install` to install required packages.
Verify installation by running `npm list`.
Create a `.env` file with your API credentials.
```bash
API_KEY=your_api_key_here
```
Never commit API keys to version control.
#### Tabs for alternative content
Example of tabbed content:
```bash
brew install node
npm install -g package-name
```
```powershell
choco install nodejs
npm install -g package-name
```
```bash
sudo apt install nodejs npm
npm install -g package-name
```
#### Accordions for collapsible content
Example of accordion groups:
- **Firewall blocking**: Ensure ports 80 and 443 are open
- **Proxy configuration**: Set HTTP_PROXY environment variable
- **DNS resolution**: Try using 8.8.8.8 as DNS server
```javascript
const config = {
performance: { cache: true, timeout: 30000 },
security: { encryption: 'AES-256' }
};
```
### Cards and columns for emphasizing information
Example of cards and card groups:
Complete walkthrough from installation to your first API call in under 10 minutes.
Learn how to authenticate requests using API keys or JWT tokens.
Understand rate limits and best practices for high-volume usage.
### API documentation components
#### Parameter fields
Example of parameter documentation:
Unique identifier for the user. Must be a valid UUID v4 format.
User's email address. Must be valid and unique within the system.
Maximum number of results to return. Range: 1-100.
Bearer token for API authentication. Format: `Bearer YOUR_API_KEY`
#### Response fields
Example of response field documentation:
Unique identifier assigned to the newly created user.
ISO 8601 formatted timestamp of when the user was created.
List of permission strings assigned to this user.
#### Expandable nested fields
Example of nested field documentation:
Complete user object with all associated data.
User profile information including personal details.
User's first name as entered during registration.
URL to user's profile picture. Returns null if no avatar is set.
### Media and advanced components
#### Frames for images
Wrap all images in frames:
#### Videos
Use the HTML video element for self-hosted video content:
Embed YouTube videos using iframe elements:
#### Tooltips
Example of tooltip usage:
API
#### Updates
Use updates for changelogs:
## New features
- Added bulk user import functionality
- Improved error messages with actionable suggestions
## Bug fixes
- Fixed pagination issue with large datasets
- Resolved authentication timeout problems
## Required page structure
Every documentation page must begin with YAML frontmatter:
```yaml
---
title: "Clear, specific, keyword-rich title"
description: "Concise description explaining page purpose and value"
---
```
## Content quality standards
### Code examples requirements
- Always include complete, runnable examples that users can copy and execute
- Show proper error handling and edge case management
- Use realistic data instead of placeholder values
- Include expected outputs and results for verification
- Test all code examples thoroughly before publishing
- Specify language and include filename when relevant
- Add explanatory comments for complex logic
- Never include real API keys or secrets in code examples
### API documentation requirements
- Document all parameters including optional ones with clear descriptions
- Show both success and error response examples with realistic data
- Include rate limiting information with specific limits
- Provide authentication examples showing proper format
- Explain all HTTP status codes and error handling
- Cover complete request/response cycles
### Accessibility requirements
- Include descriptive alt text for all images and diagrams
- Use specific, actionable link text instead of "click here"
- Ensure proper heading hierarchy starting with H2
- Provide keyboard navigation considerations
- Use sufficient color contrast in examples and visuals
- Structure content for easy scanning with headers and lists
## Component selection logic
- Use **Steps** for procedures and sequential instructions
- Use **Tabs** for platform-specific content or alternative approaches
- Use **CodeGroup** when showing the same concept in multiple programming languages
- Use **Accordions** for progressive disclosure of information
- Use **RequestExample/ResponseExample** specifically for API endpoint documentation
- Use **ParamField** for API parameters, **ResponseField** for API responses
- Use **Expandable** for nested object properties or hierarchical information
````
# Windsurf setup
Source: https://help.rarent.com/ai-tools/windsurf
Configure Windsurf for your documentation workflow
Configure Windsurf's Cascade AI assistant to help you write and maintain documentation. This guide shows how to set up Windsurf specifically for your Mintlify documentation workflow.
## Prerequisites
* Windsurf editor installed
* Access to your documentation repository
## Workspace rules
Create workspace rules that provide Windsurf with context about your documentation project and standards.
Create `.windsurf/rules.md` in your project root:
````markdown theme={null}
# Mintlify technical writing rule
## Project context
- This is a documentation project on the Mintlify platform
- We use MDX files with YAML frontmatter
- Navigation is configured in `docs.json`
- We follow technical writing best practices
## Writing standards
- Use second person ("you") for instructions
- Write in active voice and present tense
- Start procedures with prerequisites
- Include expected outcomes for major steps
- Use descriptive, keyword-rich headings
- Keep sentences concise but informative
## Required page structure
Every page must start with frontmatter:
```yaml
---
title: "Clear, specific title"
description: "Concise description for SEO and navigation"
---
```
## Mintlify components
### Callouts
- `` for helpful supplementary information
- `` for important cautions and breaking changes
- `` for best practices and expert advice
- `` for neutral contextual information
- `` for success confirmations
### Code examples
- When appropriate, include complete, runnable examples
- Use `` for multiple language examples
- Specify language tags on all code blocks
- Include realistic data, not placeholders
- Use `` and `` for API docs
### Procedures
- Use `` component for sequential instructions
- Include verification steps with `` components when relevant
- Break complex procedures into smaller steps
### Content organization
- Use `` for platform-specific content
- Use `` for progressive disclosure
- Use `` and `` for highlighting content
- Wrap images in `` components with descriptive alt text
## API documentation requirements
- Document all parameters with ``
- Show response structure with ``
- Include both success and error examples
- Use `` for nested object properties
- Always include authentication examples
## Quality standards
- Test all code examples before publishing
- Use relative paths for internal links
- Include alt text for all images
- Ensure proper heading hierarchy (start with h2)
- Check existing patterns for consistency
````
# Create Plant
Source: https://help.rarent.com/api-reference/endpoint/create
POST /plants
Creates a new plant in the store
# Delete Plant
Source: https://help.rarent.com/api-reference/endpoint/delete
DELETE /plants/{id}
Deletes a single plant based on the ID supplied
# Get Plants
Source: https://help.rarent.com/api-reference/endpoint/get
GET /plants
Returns all plants from the system that the user has access to
# New Plant
Source: https://help.rarent.com/api-reference/endpoint/webhook
WEBHOOK /plant/webhook
Information about a new plant added to the store
# Introduction
Source: https://help.rarent.com/api-reference/introduction
Example section for showcasing API endpoints
If you're not looking to build API reference documentation, you can delete
this section by removing the api-reference folder.
## Welcome
There are two ways to build API documentation: [OpenAPI](https://mintlify.com/docs/api-playground/openapi/setup) and [MDX components](https://mintlify.com/docs/api-playground/mdx/configuration). For the starter kit, we are using the following OpenAPI specification.
View the OpenAPI specification file
## Authentication
All API endpoints are authenticated using Bearer tokens and picked up from the specification file.
```json theme={null}
"security": [
{
"bearerAuth": []
}
]
```
# Development
Source: https://help.rarent.com/development
Preview changes locally to update your docs
**Prerequisites**:
* Node.js version 19 or higher
* A docs repository with a `docs.json` file
Follow these steps to install and run Mintlify on your operating system.
```bash theme={null}
npm i -g mint
```
Navigate to your docs directory where your `docs.json` file is located, and run the following command:
```bash theme={null}
mint dev
```
A local preview of your documentation will be available at `http://localhost:3000`.
## Custom ports
By default, Mintlify uses port 3000. You can customize the port Mintlify runs on by using the `--port` flag. For example, to run Mintlify on port 3333, use this command:
```bash theme={null}
mint dev --port 3333
```
If you attempt to run Mintlify on a port that's already in use, it will use the next available port:
```md theme={null}
Port 3000 is already in use. Trying 3001 instead.
```
## Mintlify versions
Please note that each CLI release is associated with a specific version of Mintlify. If your local preview does not align with the production version, please update the CLI:
```bash theme={null}
npm mint update
```
## Validating links
The CLI can assist with validating links in your documentation. To identify any broken links, use the following command:
```bash theme={null}
mint broken-links
```
## Deployment
If the deployment is successful, you should see the following:
## Code formatting
We suggest using extensions on your IDE to recognize and format MDX. If you're a VSCode user, consider the [MDX VSCode extension](https://marketplace.visualstudio.com/items?itemName=unifiedjs.vscode-mdx) for syntax highlighting, and [Prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode) for code formatting.
## Troubleshooting
This may be due to an outdated version of node. Try the following:
1. Remove the currently-installed version of the CLI: `npm remove -g mint`
2. Upgrade to Node v19 or higher.
3. Reinstall the CLI: `npm i -g mint`
Solution: Go to the root of your device and delete the `~/.mintlify` folder. Then run `mint dev` again.
Curious about what changed in the latest CLI version? Check out the [CLI changelog](https://www.npmjs.com/package/mintlify?activeTab=versions).
# Contact BuildIt support
Source: https://help.rarent.com/en/buildit/contact-support
Sample BuildIt support-routing page.
Use this page to model how BuildIt customers find help.
## Request details
Collect project reference, account email, order details, and any supporting photos.
## POC note
Replace this stub with approved support language before launch.
# BuildIt help overview
Source: https://help.rarent.com/en/buildit/overview
POC landing page for BuildIt help content.
Use this page as the BuildIt brand entry point in the multi-brand help center POC.
## Draft content areas
* Project setup
* Materials and orders
* Billing
* Support routing
This is placeholder-safe English structure for navigation validation.
# Contact Casa support
Source: https://help.rarent.com/en/casa/contact-support
Sample Casa support-routing page.
Use this page to model how Casa customers find help.
## Request details
Collect the account email, property or service reference, and any relevant photos.
## POC note
Replace this stub with approved support language before launch.
# Casa help overview
Source: https://help.rarent.com/en/casa/overview
POC landing page for Casa help content.
Use this page as the Casa brand entry point in the multi-brand help center POC.
## Draft content areas
* Home setup
* Service requests
* Account settings
* Support routing
This is placeholder-safe English structure for navigation validation.
# Contact Market support
Source: https://help.rarent.com/en/market/contact-support
Sample Market support-routing page.
Use this page to model how Market customers find help.
## Request details
Collect listing references, order references, account email, and screenshots where relevant.
## POC note
Replace this stub with approved support language before launch.
# Market help overview
Source: https://help.rarent.com/en/market/overview
POC landing page for Market help content.
Use this page as the Market brand entry point in the multi-brand help center POC.
## Draft content areas
* Buying and selling basics
* Listings
* Orders
* Trust and safety
This is placeholder-safe English structure for navigation validation.
# Contact Pludo support
Source: https://help.rarent.com/en/pludo/contact-support
Sample Pludo support-routing page.
Use this page to model how Pludo customers find help.
## Request details
Collect workspace name, account email, affected users, and screenshots when available.
## POC note
Replace this stub with approved support language before launch.
# Pludo help overview
Source: https://help.rarent.com/en/pludo/overview
POC landing page for Pludo help content.
Use this page as the Pludo brand entry point in the multi-brand help center POC.
## Draft content areas
* Workspace basics
* Team settings
* Usage questions
* Support routing
This is placeholder-safe English structure for navigation validation.
# Contact Polar support
Source: https://help.rarent.com/en/polar/contact-support
Sample Polar support-routing page.
Use this page to model how Polar customers find help.
## Request details
Collect account email, plan details, request type, and screenshots where relevant.
## POC note
Replace this stub with approved support language before launch.
# Polar help overview
Source: https://help.rarent.com/en/polar/overview
POC landing page for Polar help content.
Use this page as the Polar brand entry point in the multi-brand help center POC.
## Draft content areas
* Getting started
* Plans and access
* Product questions
* Support routing
This is placeholder-safe English structure for navigation validation.
# Account access
Source: https://help.rarent.com/en/rar/account-billing/account-access
Sample RAR account access article.
Use this article to test account-access organization for RAR.
## Sign-in issues
Document password reset, email verification, and account recovery steps after confirmation with the account team.
## Account details
Explain which profile details customers can update directly and which require support.
# Payments and invoices
Source: https://help.rarent.com/en/rar/account-billing/payments-invoices
Sample RAR billing article.
Use this page to model billing help for RAR.
## Payments
Add supported payment methods, authorization timing, and failed-payment steps after policy review.
## Invoices
Document where invoices are available and who can request invoice changes.
# Contact RAR support
Source: https://help.rarent.com/en/rar/contact-support
Placeholder support routing page for RAR customers.
Use this sample page to test support routing for the RAR brand.
## Before contacting support
Have the following details ready when available:
* Order or rental reference
* Account email address
* Delivery address or service location
* Photos or documents related to the request
## Support channels
Keep channel details aligned with the production support model before publishing this POC.
# RAR Support
Source: https://help.rarent.com/en/rar/home
Search RAR support and browse RAR products and apps.
# Delivery help
Source: https://help.rarent.com/en/rar/orders-rentals/delivery
Sample nested RAR delivery page.
Use this nested sample page to test deeper help-center navigation for delivery topics.
## Delivery status
Delivery-status content should describe where customers can check estimated timing and what updates mean.
## Delivery changes
Document which delivery details can be changed, when changes are locked, and when support should intervene.
## Missed delivery
Add the production process for missed delivery attempts after operations review.
# Manage a rental
Source: https://help.rarent.com/en/rar/orders-rentals/manage-rental
Sample RAR workflow for viewing and managing a rental.
Use this workflow page to model rental-management support content.
## Typical tasks
* Review rental status
* Update rental details where allowed
* Check delivery or pickup timing
* Request help with a rental issue
## Draft workflow
1. Sign in to the customer account.
2. Open the active rental.
3. Review available actions.
4. Contact support if the action is not available in self-service.
This is POC copy and should be validated against the live RAR customer experience.
# Returns and pickup
Source: https://help.rarent.com/en/rar/orders-rentals/returns
Sample nested RAR returns and pickup page.
Use this page to model RAR return and pickup guidance.
## Return readiness
* Confirm the return window.
* Prepare items according to the applicable policy.
* Keep access instructions current for pickup.
## Pickup issues
Add approved escalation language for failed pickup, damaged items, and timing conflicts before production launch.
# RAR help overview
Source: https://help.rarent.com/en/rar/overview
POC landing page for the RAR help center structure.
Use this page as the RAR brand entry point in the multilingual, multi-brand help center POC.
## Common paths
* Find help by topic in the left navigation.
* Route account questions to the account and billing section.
* Route order, rental, delivery, and return questions to the orders and rentals section.
## POC notes
This page is additive and does not replace existing RAR help content. Final production copy, support SLAs, and policy language should be reviewed before launch.
# Escalation paths
Source: https://help.rarent.com/en/rar/support-operations/escalations
Internal-facing sample for support escalation routing.
Use this POC page to test operational support structure.
## Escalation types
* Account access
* Billing review
* Delivery exception
* Return exception
* Product or service availability
## Ownership
Replace this placeholder with approved queues, service targets, and escalation criteria before launch.
# Contact You support
Source: https://help.rarent.com/en/you/contact-support
Sample You support-routing page.
Use this page to model how You customers find help.
## Request details
Collect the customer account email, request type, and any screenshots before escalation.
## POC note
Replace this stub with approved support language before launch.
# You help overview
Source: https://help.rarent.com/en/you/overview
POC landing page for You help content.
Use this page as the You brand entry point in the multi-brand help center POC.
## Draft content areas
* Account setup
* Profile and preferences
* Notifications
* Support routing
This is placeholder-safe English structure for navigation validation.
# Code blocks
Source: https://help.rarent.com/essentials/code
Display inline code and code blocks
## Inline code
To denote a `word` or `phrase` as code, enclose it in backticks (\`).
```
To denote a `word` or `phrase` as code, enclose it in backticks (`).
```
## Code blocks
Use [fenced code blocks](https://www.markdownguide.org/extended-syntax/#fenced-code-blocks) by enclosing code in three backticks and follow the leading ticks with the programming language of your snippet to get syntax highlighting. Optionally, you can also write the name of your code after the programming language.
```java HelloWorld.java theme={null}
class HelloWorld {
public static void main(String[] args) {
System.out.println("Hello, World!");
}
}
```
````md theme={null}
```java HelloWorld.java
class HelloWorld {
public static void main(String[] args) {
System.out.println("Hello, World!");
}
}
```
````
# Images and embeds
Source: https://help.rarent.com/essentials/images
Add image, video, and other HTML elements
## Image
### Using Markdown
The [markdown syntax](https://www.markdownguide.org/basic-syntax/#images) lets you add images using the following code
```md theme={null}
```
Note that the image file size must be less than 5MB. Otherwise, we recommend hosting on a service like [Cloudinary](https://cloudinary.com/) or [S3](https://aws.amazon.com/s3/). You can then use that URL and embed.
### Using embeds
To get more customizability with images, you can also use [embeds](/writing-content/embed) to add images
```html theme={null}
```
## Embeds and HTML elements
Mintlify supports [HTML tags in Markdown](https://www.markdownguide.org/basic-syntax/#html). This is helpful if you prefer HTML tags to Markdown syntax, and lets you create documentation with infinite flexibility.
### iFrames
Loads another HTML page within the document. Most commonly used for embedding videos.
```html theme={null}
```
# Markdown syntax
Source: https://help.rarent.com/essentials/markdown
Text, title, and styling in standard markdown
## Titles
Best used for section headers.
```md theme={null}
## Titles
```
### Subtitles
Best used for subsection headers.
```md theme={null}
### Subtitles
```
Each **title** and **subtitle** creates an anchor and also shows up on the table of contents on the right.
## Text formatting
We support most markdown formatting. Simply add `**`, `_`, or `~` around text to format it.
| Style | How to write it | Result |
| ------------- | ----------------- | ----------------- |
| Bold | `**bold**` | **bold** |
| Italic | `_italic_` | *italic* |
| Strikethrough | `~strikethrough~` | ~~strikethrough~~ |
You can combine these. For example, write `**_bold and italic_**` to get ***bold and italic*** text.
You need to use HTML to write superscript and subscript text. That is, add `` or `` around your text.
| Text Size | How to write it | Result |
| ----------- | ------------------------ | ---------------------- |
| Superscript | `superscript` | superscript |
| Subscript | `subscript` | subscript |
## Linking to pages
You can add a link by wrapping text in `[]()`. You would write `[link to google](https://google.com)` to [link to google](https://google.com).
Links to pages in your docs need to be root-relative. Basically, you should include the entire folder path. For example, `[link to text](/writing-content/text)` links to the page "Text" in our components section.
Relative links like `[link to text](../text)` will open slower because we cannot optimize them as easily.
## Blockquotes
### Singleline
To create a blockquote, add a `>` in front of a paragraph.
> Dorothy followed her through many of the beautiful rooms in her castle.
```md theme={null}
> Dorothy followed her through many of the beautiful rooms in her castle.
```
### Multiline
> 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.
```md theme={null}
> 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.
```
### LaTeX
Mintlify supports [LaTeX](https://www.latex-project.org) through the Latex component.
8 x (vk x H1 - H2) = (0,1)
```md theme={null}
8 x (vk x H1 - H2) = (0,1)
```
# Navigation
Source: https://help.rarent.com/essentials/navigation
The navigation field in docs.json defines the pages that go in the navigation menu
The navigation menu is the list of links on every website.
You will likely update `docs.json` every time you add a new page. Pages do not show up automatically.
## Navigation syntax
Our navigation syntax is recursive which means you can make nested navigation groups. You don't need to include `.mdx` in page names.
```json Regular Navigation theme={null}
"navigation": {
"tabs": [
{
"tab": "Docs",
"groups": [
{
"group": "Getting Started",
"pages": ["quickstart"]
}
]
}
]
}
```
```json Nested Navigation theme={null}
"navigation": {
"tabs": [
{
"tab": "Docs",
"groups": [
{
"group": "Getting Started",
"pages": [
"quickstart",
{
"group": "Nested Reference Pages",
"pages": ["nested-reference-page"]
}
]
}
]
}
]
}
```
## Folders
Simply put your MDX files in folders and update the paths in `docs.json`.
For example, to have a page at `https://yoursite.com/your-folder/your-page` you would make a folder called `your-folder` containing an MDX file called `your-page.mdx`.
You cannot use `api` for the name of a folder unless you nest it inside another folder. Mintlify uses Next.js which reserves the top-level `api` folder for internal server calls. A folder name such as `api-reference` would be accepted.
```json Navigation With Folder theme={null}
"navigation": {
"tabs": [
{
"tab": "Docs",
"groups": [
{
"group": "Group Name",
"pages": ["your-folder/your-page"]
}
]
}
]
}
```
## Hidden pages
MDX files not included in `docs.json` will not show up in the sidebar but are accessible through the search bar and by linking directly to them.
# Reusable snippets
Source: https://help.rarent.com/essentials/reusable-snippets
Reusable, custom snippets to keep content in sync
One of the core principles of software development is DRY (Don't Repeat
Yourself). This is a principle that applies to documentation as
well. If you find yourself repeating the same content in multiple places, you
should consider creating a custom snippet to keep your content in sync.
## Creating a custom snippet
**Pre-condition**: You must create your snippet file in the `snippets` directory.
Any page in the `snippets` directory will be treated as a snippet and will not
be rendered into a standalone page. If you want to create a standalone page
from the snippet, import the snippet into another file and call it as a
component.
### Default export
1. Add content to your snippet file that you want to re-use across multiple
locations. Optionally, you can add variables that can be filled in via props
when you import the snippet.
```mdx snippets/my-snippet.mdx theme={null}
Hello world! This is my content I want to reuse across pages. My keyword of the
day is {word}.
```
The content that you want to reuse must be inside the `snippets` directory in
order for the import to work.
2. Import the snippet into your destination file.
```mdx destination-file.mdx theme={null}
---
title: My title
description: My Description
---
import MySnippet from '/snippets/path/to/my-snippet.mdx';
## Header
Lorem impsum dolor sit amet.
```
### Reusable variables
1. Export a variable from your snippet file:
```mdx snippets/path/to/custom-variables.mdx theme={null}
export const myName = 'my name';
export const myObject = { fruit: 'strawberries' };
```
2. Import the snippet from your destination file and use the variable:
```mdx destination-file.mdx theme={null}
---
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}.
```
### Reusable components
1. Inside your snippet file, create a component that takes in props by exporting
your component in the form of an arrow function.
```mdx snippets/custom-component.mdx theme={null}
export const MyComponent = ({ title }) => (
{title}
... snippet content ...
);
```
MDX does not compile inside the body of an arrow function. Stick to HTML
syntax when you can or use a default export if you need to use MDX.
2. Import the snippet into your destination file and pass in the props
```mdx destination-file.mdx theme={null}
---
title: My title
description: My Description
---
import { MyComponent } from '/snippets/custom-component.mdx';
Lorem ipsum dolor sit amet.
```
# Global Settings
Source: https://help.rarent.com/essentials/settings
Mintlify gives you complete control over the look and feel of your documentation using the docs.json file
Every Mintlify site needs a `docs.json` file with the core configuration settings. Learn more about the [properties](#properties) below.
## Properties
Name of your project. Used for the global title.
Example: `mintlify`
An array of groups with all the pages within that group
The name of the group.
Example: `Settings`
The relative paths to the markdown files that will serve as pages.
Example: `["customization", "page"]`
Path to logo image or object with path to "light" and "dark" mode logo images
Path to the logo in light mode
Path to the logo in dark mode
Where clicking on the logo links you to
Path to the favicon image
Hex color codes for your global theme
The primary color. Used for most often for highlighted content, section headers, accents, in light mode
The primary color for dark mode. Used for most often for highlighted content, section headers, accents, in dark mode
The primary color for important buttons
The color of the background in both light and dark mode
The hex color code of the background in light mode
The hex color code of the background in dark mode
Array of `name`s and `url`s of links you want to include in the topbar
The name of the button.
Example: `Contact us`
The url once you click on the button. Example: `https://mintlify.com/docs`
Link shows a button. GitHub shows the repo information at the url provided including the number of GitHub stars.
If `link`: What the button links to.
If `github`: Link to the repository to load GitHub information from.
Text inside the button. Only required if `type` is a `link`.
Array of version names. Only use this if you want to show different versions of docs with a dropdown in the navigation bar.
An array of the anchors, includes the `icon`, `color`, and `url`.
The [Font Awesome](https://fontawesome.com/search?q=heart) icon used to feature the anchor.
Example: `comments`
The name of the anchor label.
Example: `Community`
The start of the URL that marks what pages go in the anchor. Generally, this is the name of the folder you put your pages in.
The hex color of the anchor icon background. Can also be a gradient if you pass an object with the properties `from` and `to` that are each a hex color.
Used if you want to hide an anchor until the correct docs version is selected.
Pass `true` if you want to hide the anchor until you directly link someone to docs inside it.
One of: "brands", "duotone", "light", "sharp-solid", "solid", or "thin"
Override the default configurations for the top-most anchor.
The name of the top-most anchor
Font Awesome icon.
One of: "brands", "duotone", "light", "sharp-solid", "solid", or "thin"
An array of navigational tabs.
The name of the tab label.
The start of the URL that marks what pages go in the tab. Generally, this is the name of the folder you put your pages in.
Configuration for API settings. Learn more about API pages at [API Components](/api-playground/demo).
The base url for all API endpoints. If `baseUrl` is an array, it will enable for multiple base url options that the user can toggle.
The authentication strategy used for all API endpoints.
The name of the authentication parameter used in the API playground.
If method is `basic`, the format should be `[usernameName]:[passwordName]`
The default value that's designed to be a prefix for the authentication input field.
E.g. If an `inputPrefix` of `AuthKey` would inherit the default input result of the authentication field as `AuthKey`.
Configurations for the API playground
Whether the playground is showing, hidden, or only displaying the endpoint with no added user interactivity `simple`
Learn more at the [playground guides](/api-playground/demo)
Enabling this flag ensures that key ordering in OpenAPI pages matches the key ordering defined in the OpenAPI file.
This behavior will soon be enabled by default, at which point this field will be deprecated.
A string or an array of strings of URL(s) or relative path(s) pointing to your OpenAPI file.
Examples:
```json Absolute theme={null}
"openapi": "https://example.com/openapi.json"
```
```json Relative theme={null}
"openapi": "/openapi.json"
```
```json Multiple theme={null}
"openapi": ["https://example.com/openapi1.json", "/openapi2.json", "/openapi3.json"]
```
An object of social media accounts where the key:property pair represents the social media platform and the account url.
Example:
```json theme={null}
{
"x": "https://x.com/rentonRAR",
"Instagram": "https://instagram.com/rar.rent",
"website": "https://rarent.com"
}
```
One of the following values `website`, `facebook`, `x`, `discord`, `slack`, `github`, `linkedin`, `instagram`, `hacker-news`
Example: `x`
The URL to the social platform.
Example: `https://x.com/mintlify`
Configurations to enable feedback buttons
Enables a button to allow users to suggest edits via pull requests
Enables a button to allow users to raise an issue about the documentation
Customize the dark mode toggle.
Set if you always want to show light or dark mode for new users. When not set, we default to the same mode as the user's operating system.
Set to true to hide the dark/light mode toggle. You can combine `isHidden` with `default` to force your docs to only use light or dark mode. For example:
```json Only Dark Mode theme={null}
"modeToggle": {
"default": "dark",
"isHidden": true
}
```
```json Only Light Mode theme={null}
"modeToggle": {
"default": "light",
"isHidden": true
}
```
A background image to be displayed behind every page. See example with [Infisical](https://infisical.com/docs) and [FRPC](https://frpc.io).
# Introduction
Source: https://help.rarent.com/index
Welcome to the RAR Help Center. How can we help?
## Holiday Shopping
Get answers to holiday shopping questions.
## Setting up
Get started with RAR in less than 5 minutes — and get access to our full ecosystem
Follow our three step quickstart guide.
## Make it yours
Design a docs site that looks great and empowers your users.
Edit your docs locally and preview them in real time.
Customize the design and colors of your site to match your brand.
Organize your docs to help users find what they need and succeed with your product.
Auto-generate API documentation from OpenAPI specifications.
Get started with our app and explore helpful features.
## Create beautiful pages
Everything you need to create world-class documentation.
Use MDX to style your docs pages.
Add sample code to demonstrate how to use your product.
Display images and other media.
Write once and reuse across your docs.
## Need inspiration?
Browse our showcase of exceptional documentation sites.
# Quickstart
Source: https://help.rarent.com/quickstart
Get started with RAR in under 5 minutes.
## Get started in three steps
Get your documentation site running locally and make your first customization.
### Step 1: Set up your local environment
During the onboarding process, you created a GitHub repository with your docs content if you didn't already have one. You can find a link to this repository in your [dashboard](https://dashboard.mintlify.com).
To clone the repository locally so that you can make and preview changes to your docs, follow the [Cloning a repository](https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository) guide in the GitHub docs.
1. Install the Mintlify CLI: `npm i -g mint`
2. Navigate to your docs directory and run: `mint dev`
3. Open `http://localhost:3000` to see your docs live!
Your preview updates automatically as you edit files.
### Step 2: Deploy your changes
Install the Mintlify GitHub app from your [dashboard](https://dashboard.mintlify.com/settings/organization/github-app).
Our GitHub app automatically deploys your changes to your docs site, so you don't need to manage deployments yourself.
For a first change, let's update the name and colors of your docs site.
1. Open `docs.json` in your editor.
2. Change the `"name"` field to your project name.
3. Update the `"colors"` to match your brand.
4. Save and see your changes instantly at `http://localhost:3000`.
Try changing the primary color to see an immediate difference!
### Step 3: Go live
1. Commit and push your changes.
2. Your docs will update and be live in moments!
## Next steps
Now that you have your docs running, explore these key features:
Learn MDX syntax and start writing your documentation.
Make your docs match your brand perfectly.
Include syntax-highlighted code blocks.
Auto-generate API docs from OpenAPI specs.
**Need help?** See our [full documentation](https://mintlify.com/docs) or join our [community](https://mintlify.com/community).
```
## Embeds and HTML elements
#### Videos
Use the HTML video element for self-hosted video content:
Embed YouTube videos using iframe elements:
#### Tooltips
Example of tooltip usage: