Skip to content

Commit

Permalink
docs: Cairo dependency described in the MkDocs section
Browse files Browse the repository at this point in the history
  • Loading branch information
mpusz committed Feb 22, 2024
1 parent cc05323 commit e37c83d
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 8 deletions.
10 changes: 2 additions & 8 deletions .gitpod/Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,12 @@ FROM trainiteu/gitpod-cpp

# Add clang apt repositories
RUN lsb_rel=`lsb_release -cs` && \
sudo add-apt-repository "deb http://apt.llvm.org/${lsb_rel}/ llvm-toolchain-${lsb_rel}-16 main"
sudo add-apt-repository "deb http://apt.llvm.org/${lsb_rel}/ llvm-toolchain-${lsb_rel}-16 main"

# Install older compilers supported by the project
RUN sudo install-packages \
g++-12 \
clang-16

# Install mkdocs dependencies
RUN sudo install-packages \
libcairo2-dev \
libfreetype6-dev \
libffi-dev \
libjpeg-dev \
libpng-dev \
libz-dev
RUN sudo install-packages
4 changes: 4 additions & 0 deletions docs/getting_started/installation_and_usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -475,6 +475,10 @@ is with `pip`:
pip install -U mkdocs-material mkdocs-rss-plugin
```
Additionally, a [Cairo Graphics library](https://www.cairographics.org/) is required by
Material for MkDocs. Please follow the
[official MkDocs documentation to install it](https://squidfunk.github.io/mkdocs-material/plugins/requirements/image-processing/#cairo-graphics).
After that, you can either:
- easily [start a live server to preview the documentation as you write](https://squidfunk.github.io/mkdocs-material/creating-your-site/#previewing-as-you-write)
Expand Down

0 comments on commit e37c83d

Please sign in to comment.