Add Docker image for local development (#462)

Co-authored-by: Antonio Vivace <[email protected]>

Author: leinacc

DEPLOY.md

@@ -1,6 +1,45 @@
-## Deploy
+# Deploy
 
-This document will explain you how to run a local copy of Pan Docs. 
+This document will explain you how to set up a local copy of Pan Docs.
+
+```sh
+# Start by cloning the repository
+git clone https://github.com/gbdev/pandocs.git
+# and moving to the pandocs directory
+cd pandocs
+```
+
+## Docker
+
+If you have [Docker installed](https://docs.docker.com/engine/install/), you can pull and use the provided image by running:
+
+```sh
+docker run -p 8001:8000 \
+  --mount "type=bind,source=$(pwd)/custom,target=/code/custom" \
+  --mount "type=bind,source=$(pwd)/preproc,target=/code/preproc" \
+  --mount "type=bind,source=$(pwd)/renderer,target=/code/renderer" \
+  --mount "type=bind,source=$(pwd)/src,target=/code/src" \
+  --mount "type=bind,source=$(pwd)/theme,target=/code/theme" \
+  -it ghcr.io/gbdev/pandocs
+```
+
+That's it! Pan Docs is live at [localhost:8001](https://localhost:8001).
+
+Be aware of the following caveat:
+
+- The locally running site will not update from changes to files in the `theme/` or `custom/` directories (e.g. highlight.js builds, CSS style overrides). You must trigger the build by manually changing a file in the `src/` directory.
+
+### Building the image
+
+If you prefer to build the image yourself:
+
+```sh
+docker build -t pandocs .
+```
+
+## Local
+
+If you prefer to install every dependency locally:
 
 1. Install [Rust](https://www.rust-lang.org/tools/install), [mdBook](https://github.com/rust-lang/mdBook#readme), and [Python 3](https://www.python.org/downloads) (3.9 or an earlier version).
   mdBook is the tool rendering the documentation, Rust is used for some custom plugins and Python scripts are used to render some images. E.g.:
@@ -42,11 +81,11 @@ Be aware of the following caveats:
 
 - `mdbook watch` and `mdbook serve` do *not* watch for changes to files in the `theme/` or `custom/` directories (e.g. highlight.js builds, CSS style overrides). You must trigger the build by either restarting the command, or manually changing one of the watched files.
 
-### Special markup
+## Special markup
 
 Pan Docs uses a custom mdBook preprocessor & renderer to enable some special markup:
 
-#### Custom Containers 
+### Custom Containers 
 
 Those mimick Vuepress' [custom containers](https://vuepress.vuejs.org/guide/markdown.html#custom-containers) functionality.
 
@@ -79,7 +118,7 @@ will render as
 
 <img src=".github/example_container.png"></img>
 
-#### Internal links
+### Internal links
 
 ```markdown
 [VRAM Sprite Attribute Table (OAM)](<#VRAM Sprite Attribute Table (OAM)>)
@@ -91,7 +130,7 @@ Note that the angle brackets [are only required if there are spaces in the URL](
 
 In effect, this means that linking to a section is as simple as copy-pasting its name in the URL field, prepending a `#`, and wrapping everything in `<>` if the name contains a space.
 
-### Syntax highlighting
+## Syntax highlighting
 
 Syntax highlighting is provided within the browser, courtesy of [`highlight.js`](https://github.com/highlightjs/highlight.js).
 [RGBASM syntax](https://rgbds.gbdev.io/docs/rgbasm.5) is highlighted via [a plugin](https://github.com/gbdev/highlightjs-rgbasm), but this requires a custom build of `highlight.js`.
@@ -121,7 +160,7 @@ node tools/build.js -t browser rgbasm c
 cp build/highlight.min.js ../pandocs/theme/highlight.js
 ```
 
-### Folder structure
+## Folder structure
 
 ```
 .

Dockerfile

@@ -0,0 +1,24 @@
+# Get a python 3.10 image
+FROM python:3.10.9
+LABEL org.opencontainers.image.source=https://github.com/gbdev/pandocs
+SHELL ["bash", "-lc"]
+RUN apt update
+RUN apt install curl -y
+
+# Install rust and mdbook
+RUN curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh -s -- -y
+RUN apt install gcc -y
+RUN source "$HOME/.cargo/env"
+RUN cargo install mdbook
+
+COPY . /code
+WORKDIR /code
+
+# Init python3 env
+RUN python -m venv env
+RUN source env/bin/activate
+RUN pip install -r requirements.txt
+
+# Serve pandocs at localhost:8000
+RUN mdbook build
+CMD mdbook watch & (cd /code/docs/pandocs/ && python3 -m http.server)