mistralai/platform-docs-public

mistralai/platform-docs-public

Language: MDX

License: Apache-2.0

Stars: 67

Forks: 125

Open issues: 63

Created: 2023-12-22T17:21:55Z

Pushed: 2026-06-09T08:54:18Z

Default branch: main

Fork: no

Archived: no

README:

Mistral AI LLM documentation

This folder contains the documentation of the Mistral LLM setup and APIs.

Please follow the following steps to ensure your changes can be deployed successfully.

Cloning the Project

To clone the Mistral AI LLM project, including all necessary submodules, follow these steps:

1. Clone the Repository: Use the --recurse-submodules flag to ensure all submodules are cloned along with the main repository:

git clone --recurse-submodules

2. Navigate to the Project Directory: After cloning, navigate into the project directory:

cd

3. Verify Submodules: Ensure that all submodules are initialized and updated:

git submodule update --init --recursive

Ensure that you commit any changes to submodules to keep the repository consistent.

Project Setup

You will need to install pnpm and node first. For example, if you are using Mac, You can install Homebrew and then install pnpm and node:

brew install pnpm
brew install node

Installation

pnpm install

Local Development

pnpm dev

This command starts a local development server at http://localhost:3000. Most changes are reflected live without having to restart the server.

Build

pnpm build

This command generates a production build in the .next directory.

Cookbooks

You can add a cookbook in the docs by adding a cookbook object to the cookbooks.config.json file:

{
"path": "your/path/your-file-name.ipynb",
"labels": {
"integrations": [],
"useCases": [
"Your use case"
]
},
"availableInDocs": "True",
"title": "",
"mainSection": {
"featured": "False",
"latest": "True"
}
}

If the title is empty, the title will be extracted from the cookbook.

Troubleshoot

• Make sure URLs start with https:// or http://, otherwise, it will look for the relative paths in the repo.
• Images can be saved in the img folder. Please reference the images with /img/your_added_image.svg.

How to contribute?

Mistral AI is committed to open source software development and welcomes external contributions. Please head on to our contribution guideline.