Add unified documentation framework (#68)

* docs: initialise MkDocs

* docs: add contributing details

---------

Co-authored-by: mattcce <[email protected]>

Author: mattcce

docs/unified/.gitignore

@@ -0,0 +1 @@
+site

docs/unified/docs/contributing.md

@@ -0,0 +1,30 @@
+# Contributing
+
+### First-Time Setup
+
+Requirements:
+
+- Python `≥3.9.6`
+- [`virtualenv`](https://virtualenv.pypa.io/en/latest/installation.html) (or any virtual environment manager of choice)
+
+**Configuring virtual environment**
+
+1. Navigate to `java-slang/docs/unified`.
+2. Create new virtual environment: `python -m virtualenv .venv`.
+3. Move into virtual environment: `source .venv/bin/activate`.
+4. Get dependencies: `pip install -r requirements.txt`.
+
+The virtual environment may be exited with `deactivate`.
+
+### Development
+
+_All commands here, unless otherwise stated, are run in the virtual environment and from the docs root `java-slang/docs/unified/docs`._
+
+**Build**: `mkdocs build`
+
+**Run Live Server (Offline)**: `mkdocs serve`
+
+See relevant documentation:
+
+- [Markdown](https://daringfireball.net/projects/markdown/)
+- [Material](https://squidfunk.github.io/mkdocs-material/reference/) (for added components)

docs/unified/docs/index.md

@@ -0,0 +1,3 @@
+# `java-slang`
+
+This is the user-facing documentation for [`java-slang`](https://github.com/source-academy/java-slang).

docs/unified/mkdocs.yml

@@ -0,0 +1,24 @@
+site_name: java-slang
+
+nav:
+  - Introduction: index.md
+  - Contributing: contributing.md
+
+repo_url: https://github.com/source-academy/java-slang
+repo_name: source-academy/java-slang
+
+theme:
+  name: material
+  palette: 
+
+    # Palette toggle for light mode
+    - scheme: default
+      toggle:
+        icon: material/brightness-7 
+        name: Switch to dark mode
+
+    # Palette toggle for dark mode
+    - scheme: slate
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode

docs/unified/requirements.txt

@@ -0,0 +1,31 @@
+babel==2.17.0
+backrefs==5.8
+certifi==2025.1.31
+charset-normalizer==3.4.1
+click==8.1.8
+colorama==0.4.6
+ghp-import==2.1.0
+idna==3.10
+importlib_metadata==8.6.1
+Jinja2==3.1.6
+Markdown==3.7
+MarkupSafe==3.0.2
+mergedeep==1.3.4
+mkdocs==1.6.1
+mkdocs-get-deps==0.2.0
+mkdocs-material==9.6.10
+mkdocs-material-extensions==1.3.1
+packaging==24.2
+paginate==0.5.7
+pathspec==0.12.1
+platformdirs==4.3.7
+Pygments==2.19.1
+pymdown-extensions==10.14.3
+python-dateutil==2.9.0.post0
+PyYAML==6.0.2
+pyyaml_env_tag==0.1
+requests==2.32.3
+six==1.17.0
+urllib3==2.3.0
+watchdog==6.0.0
+zipp==3.21.0