https://github.com/mistralai/platform-docs-public
https://github.com/mistralai/platform-docs-public
Last synced: 7 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mistralai/platform-docs-public
- Owner: mistralai
- License: apache-2.0
- Created: 2023-12-22T17:21:55.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-17T07:32:25.000Z (about 1 year ago)
- Last Synced: 2024-10-19T13:01:36.727Z (about 1 year ago)
- Language: JavaScript
- Size: 17.1 MB
- Stars: 24
- Watchers: 20
- Forks: 55
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- jimsghstars - mistralai/platform-docs-public - (JavaScript)
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.
### Set up
You will need to install `pnpm` and `node` first. For example, if you are using Mac, You can install [Homebrew](https://brew.sh/) and then install `pnpm` and `node`:
```
brew install pnpm
brew install node
```
### Installation
```bash
pnpm install
```
### Local Development
```bash
pnpm start
```
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
### Build
```bash
pnpm build
```
This command generates static content into the `build` directory and can be served using any static contents hosting service.
### 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](https://github.com/mistralai/platform-docs-public/tree/main/static/img) folder. Please reference the images with `/img/your_added_image.svg`.
This documentation is built using [Docusaurus](https://docusaurus.io/).
# How to contribute?
Mistral AI is committed to open source software development and welcomes external contributions. Please head on to our [contribution guideline](https://docs.mistral.ai/guides/contribute/overview).