Merge pull request #39 from mmacy/mkdocs-site-work

mkdocs-material setup

docs/index.md

@@ -1,17 +1,9 @@
-# Welcome to MkDocs
+# OSR Console
 
-For full documentation visit [mkdocs.org](https://www.mkdocs.org).
+OSR Console is an experimental turn-based dungeon crawler RPG in the old-school renaissance (OSR) style for your terminal.
 
-## Commands
+## Packages
 
-* `mkdocs new [dir-name]` - Create a new project.
-* `mkdocs serve` - Start the live-reloading docs server.
-* `mkdocs build` - Build the documentation site.
-* `mkdocs -h` - Print help message and exit.
-
-## Project layout
-
-    mkdocs.yml    # The configuration file.
-    docs/
-        index.md  # The documentation homepage.
-        ...       # Other markdown pages, images and other files.
+- [osrlib](osrlib.md) - Turn-based RPG game engine library.
+- [osrgame](osrgame.md) - Demo console application built with the [Textual](https://textual.textualize.io/) TUI framework.
+- [tests](tests.md) - Pytest-based unit and integration tests for `osrlib`.

docs/main.css

@@ -0,0 +1,24 @@
+.md-content__inner a {
+    color: #d17d00; /* Change for normal state */
+}
+
+.md-content__inner a:hover {
+    color: #ffa600; /* Change for hover state */
+}
+
+.md-nav__link {
+    color: #d17d00; /* Change for normal state */
+}
+
+.md-nav__link:hover, .md-nav__link--active {
+    color: #ffa600; /* Change for hover and active states */
+}
+
+.md-nav__item--active > .md-nav__link--active {
+    color: #ffa600; /* Replace with your desired color */
+}
+
+.md-nav__item--active > .md-nav__link,
+.md-nav__item--active .md-nav__link--active {
+    color: #ffa600; /* Replace with your desired color for active folder links */
+}

docs/osrgame.md

@@ -0,0 +1,3 @@
+# osrgame
+
+--8<-- "osrgame/README.md:2"

docs/osrlib.md

@@ -0,0 +1,3 @@
+# osrlib
+
+--8<-- "osrlib/README.md:2"

docs/tests.md

@@ -0,0 +1,3 @@
+# tests
+
+--8<-- "tests/README.md:2"

mkdocs.yml

@@ -1 +1,77 @@
-site_name: My Docs
+site_name: OSR Console Documentation
+site_author: Marsh Macy
+site_description: Adventures in turn-based text
+site_url: https://osrapps.github.io/osr-console
+repo_name: osr-console
+repo_url: https://github.com/osrapps/osr-console
+
+theme:
+  name: material
+  logo: assets/logo-osr-apps.png
+  favicon: assets/logo-osr-apps.png
+  icon:
+    repo: fontawesome/brands/github
+
+  palette:
+    - media: "(prefers-color-scheme: light)"
+      scheme: default
+      primary: blue grey
+      accent: orange
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - media: "(prefers-color-scheme: dark)"
+      scheme: slate
+      primary: blue grey
+      accent: orange
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+
+  font:
+    text: Sora
+    #text: PT Sans Caption
+    #text: Actor
+    #text: Alef
+    #text: Palanquin
+
+    code: Martian Mono
+    #code: JetBrains Mono
+    #code: BIZ UDPGothic
+    #code: Palanquin Dark
+    #code: Oxygen Mono
+    #code: IBM Plex Mono
+
+  features:
+    - navigation.instant
+    - navigation.instant.progress
+    - navigation.tracking
+    - navigation.sections
+    - navigation.prune
+    - navigation.indexes
+    - navigation.top
+    - navigation.footer
+    - toc.follow
+
+    - search.suggest
+    - search.highlight
+    - search.share
+
+    - header.autohide
+
+markdown_extensions:
+  - attr_list
+  - md_in_html
+  - pymdownx.emoji:
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
+  - pymdownx.highlight:
+      anchor_linenums: true
+      line_spans: __span
+      pygments_lang_class: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
+
+extra_css:
+  - 'main.css'

osrlib/pyproject.toml

@@ -16,6 +16,7 @@ black = "^23.9.1"
 flake8 = "^6.1.0"
 flake8-docstrings = "^1.7.0"
 mkdocs-material = "^9.4.6"
+mkdocstrings = "^0.24.0"
 pytest = "^7.4.2"
 pytest-cov = "^4.1.0"
 pytest-mock = "^3.12.0"