Merge pull request #269 from carenalgas/feature/267-site-rebranding

refs  #267 - Project site rebranding

docs/Dockerfile.MkDocs

@@ -1,3 +1,7 @@
 FROM minidocks/mkdocs:latest
 
-RUN pip install mkdocs-nav-weight
+RUN pip install mkdocs-nav-weight mkdocs-mermaid2-plugin fontawesome-markdown
+
+# Patch fontawesome_markdown to support Python Markdown > 3.4
+# TODO: Remove this when the upstream package is updated
+COPY ./patches/fontawesome_markdown /usr/lib/python3.12/site-packages/fontawesome_markdown

docs/Makefile

@@ -9,6 +9,11 @@ docs-up:
 docs-down:
 	docker compose down
 
+docs-restart: docs-down docs-up
+
+docs-rebuild:
+	docker compose build --no-cache
+
 docs-deploy: docs-extract
 	rm -rf ./dist && git restore dist
 	docker compose run \

docs/docker-compose.yml

@@ -1,4 +1,3 @@
-version: "3"
 services:
     documentation:
         ports:

docs/mkdocs.yml

@@ -6,10 +6,15 @@ repo_url: https://github.com/carenalgas/popochiu/
 edit_uri: edit/develop/docs/src/
 docs_dir: src
 site_dir: dist
-theme: readthedocs
+site_favicon: assets/images/_other/theme/favicon.ico
+theme:
+  name: readthedocs
+  titles_only: true
+  logo: assets/images/_other/theme/logo.svg
 extra_css:
   - assets/css/custom.css
   - https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/tomorrow-night-bright.min.css
+  - https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.5.1/css/all.min.css
 extra_javascript:
   - https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js
   - https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/languages/markdown.min.js
@@ -22,6 +27,9 @@ extra_javascript:
   - assets/js/custom.js
 markdown_extensions:
   - admonition
+  - fontawesome_markdown
+  - attr_list
 plugins:
   - search
   - mkdocs-nav-weight
+  - mermaid2

docs/patches/fontawesome_markdown/__init__.py

@@ -0,0 +1 @@
+from .main import FontAwesomeInlineProcessor, FontAwesomeExtension, FontAwesomeException, makeExtension # NOQA