feat: enhance MkDocs setup and documentation, add .gitignore for project files

Author: dataGriff

.gitignore

@@ -0,0 +1,82 @@
+# MkDocs
+/site/
+.cache/
+
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# Virtual environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# IDE
+.vscode/settings.json
+.vscode/launch.json
+.vscode/tasks.json
+.vscode/.ropeproject
+.idea/
+*.swp
+*.swo
+*~
+
+# OS
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+
+# Logs
+*.log
+logs/
+
+# Temporary files
+*.tmp
+*.temp
+.tmp/
+.temp/
+
+# Node.js (if using any Node-based tools)
+node_modules/
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+package-lock.json
+yarn.lock
+
+# Backup files
+*.bak
+*.backup
+*~
+
+# Task
+.task/
+.task/**
+**/.task/

.vscode/settings.json

@@ -1,7 +1,16 @@
 {
     "cSpell.words": [
         "codebaseinterface",
+        "fontawesome",
+        "inlinehilite",
+        "linenums",
+        "livereload",
+        "mkdocs",
+        "pymdown",
+        "pymdownx",
         "RUNBOOK",
-        "taskfile"
+        "superfences",
+        "taskfile",
+        "vars"
     ]
 }

CONTRIBUTING.md

@@ -21,3 +21,9 @@ task --version
 ```bash
 task --list
 ```
+
+## Docs
+
+```bash
+pip install mkdocs mkdocs-material mkdocs-git-revision-date-localized-plugin
+```

Taskfile.yml

@@ -11,3 +11,21 @@ tasks:
     cmds:
       - echo "{{.GREETING}}"
     silent: true
+
+  setup: 
+    desc: Set up the development environment
+    cmds:
+      - pip install mkdocs-material
+      - pip install mkdocs-git-revision-date-localized-plugin
+      - pip install pymdown-extensions
+    silent: true
+
+  build:
+    desc: Build the MkDocs site
+    cmds:
+      - mkdocs build --strict
+
+  run:
+    desc: Run codebaseinterface locally
+    cmds:
+      - mkdocs serve --livereload

docs/index.md

@@ -0,0 +1,5 @@
+# Codebase Interface
+
+## Principles
+
+test test 1

mkdocs.yml

@@ -0,0 +1,59 @@
+site_name: Codebase Interface
+site_description: A documented set of principles that aim to promote the ease of use of codebases across languages and frameworks
+site_url: https://codebaseinterface.org
+repo_url: https://github.com/codebaseinterface/codebaseinterface
+repo_name: codebaseinterface/codebaseinterface
+edit_uri: edit/main/docs/
+
+theme:
+  name: material
+  features:
+    - navigation.tabs
+    - navigation.sections
+    - navigation.expand
+    - navigation.top
+    - search.highlight
+    - search.share
+    - content.code.copy
+    - content.action.edit
+  palette:
+    - scheme: default
+      primary: blue
+      accent: blue
+      toggle:
+        icon: material/brightness-7
+        name: Switch to dark mode
+    - scheme: slate
+      primary: blue
+      accent: blue
+      toggle:
+        icon: material/brightness-4
+        name: Switch to light mode
+
+nav:
+  - Home: index.md
+
+plugins:
+  - search
+  - git-revision-date-localized:
+      type: date
+
+markdown_extensions:
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
+  - admonition
+  - pymdownx.details
+  - attr_list
+  - md_in_html
+  - toc:
+      permalink: true
+
+extra:
+  social:
+    - icon: fontawesome/brands/github
+      link: https://github.com/codebaseinterface/codebaseinterface
+
+copyright: Copyright © 2023-2025 Codebase Interface Contributors