Merge pull request #1 from marcobarilari/main

add mkdocs files

Author: marcobarilari

mkdocs.yml

@@ -0,0 +1,49 @@
+---
+site_name: CPP Lab datasets
+repo_url: https://github.com/marcobarilari/Datasets.git
+
+nav:
+- CPP Lab raw data:
+  - Home: README.md
+  - Contributing: CONTRIBUTING.md
+
+theme:
+  name: material
+  features:
+  - navigation.top
+  - content.action.edit
+  icon:
+    repo: fontawesome/brands/github
+    edit: material/pencil
+  palette:
+    # Palette toggle for automatic mode
+  - media: (prefers-color-scheme)
+    toggle:
+      icon: material/brightness-auto
+      name: Switch to light mode
+    # Palette toggle for light mode
+  - media: '(prefers-color-scheme: light)'
+    scheme: default
+    toggle:
+      icon: material/brightness-7
+      name: Switch to dark mode
+    # Palette toggle for dark mode
+  - media: '(prefers-color-scheme: dark)'
+    scheme: slate
+    toggle:
+      icon: material/brightness-4
+      name: Switch to system preference
+
+edit_uri: edit/main/src/
+
+markdown_extensions:
+- toc:
+    anchorlink: true
+- pymdownx.superfences
+
+plugins:
+- search
+
+docs_dir: src
+
+use_directory_urls: false

requirements.txt

@@ -0,0 +1,5 @@
+mkdocs>=1.1
+mkdocs-material>=5.4
+pre-commit
+black
+flake8

src/CONTRIBUTING.md

@@ -0,0 +1,28 @@
+# CONTRIBUTING
+
+- fork this repository
+- clone your forked repository
+- install the dependencies
+
+```bash
+pip install -r requirements.txt
+```
+
+- create a branch
+- make your changes
+- visualize your changes
+
+```bash
+mkdocs serve
+```
+
+This should serve the doc locally on a localhost port.
+
+Something like:
+
+```
+Serving on http://127.0.0.1:8000/
+```
+
+- push your changes to your forked repository
+- open a pull request