Skip to content

Commit

Permalink
docs: add note to install pandoc (#2489)
Browse files Browse the repository at this point in the history
  • Loading branch information
inclinedadarsh authored Jan 11, 2025
1 parent 00235ac commit 864e9ab
Showing 1 changed file with 15 additions and 0 deletions.
15 changes: 15 additions & 0 deletions docs/developer_guide/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,21 @@ pip install --editable .[docs]
cd docs
```

> **Note:** If you are using Linux or MacOS, you'll have to install [**Pandoc**](https://pandoc.org/) as a dependency. Install it using the following command:
>
> If you're using any Debian based system, you can use the following command to install Pandoc:
> ```bash
> sudo apt install pandoc
> ```
>
> If you're using MacOS, you can use the following command to install Pandoc:
> ```bash
> brew install pandoc
> ```
>
> For all other operating systems, please checkout the [Pandoc installation guide](https://pandoc.org/installing.html).
>
3. To build the website locally, run:
```powershell
Expand Down

0 comments on commit 864e9ab

Please sign in to comment.