starting mkdocs material

Author: LCrossman

docs/index.md

@@ -0,0 +1,33 @@
+# Welcome to micro**BioRust**
+
+A blazing-fast, sustainable bioinformatics toolkit written in [Rust](https://www.rust-lang.org/) — for microbial genomics, file parsing, and data exploration.
+
+---
+
+## Features
+
+- ⚡ High-performance parsing for Bioinformatics (e.g. GenBank, GFF3, EMBL)
+- 🦀 Built in Rust for speed and safety
+- 🔄 Python bindings via PyO3 for InterOp - Rust meets Python
+- 📦 Open source and community-driven
+
+---
+
+## Get Started
+
+Add to your Cargo.toml
+```cargo add microBioRust```
+
+to add the whole workspace
+```cargo add seqmetrics  
+cargo add heatmap  
+cargo add microbiorust-py```
+
+or clone the repo  
+```git clone https://github.com/LFloffman/microBioRust.git```
+
+Build the project  
+```cargo build```
+
+Run all the tests  
+```cargo test```

docs/installation.md

@@ -0,0 +1,35 @@
+**How to Install**
+
+**Install Rust (recommended method):**
+
+Please see [here](https://www.rust-lang.org/tools/install) for base environment installation details for Rust programming language 
+
+For MacOSX, Linux or other unix OS you can install Rust _via_:
+
+```curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh```
+
+For further details on Windows please see: [other install](https://forge.rust-lang.org/infra/other-installation-methods.html)
+
+**Install with Conda:**  
+*Disclaimer:* While conda is a powerful package manager, it is primarily designed for managing Python environments, and the 
+Rust package available may not always be up-to-date or include all the necessary components
+
+```conda install conda-forge::rust```
+
+
+**Install with Python for Rust with Python InterOp**  
+To use Python Interoperability you will need to install Python and additionally you may need (even if in a conda environment):
+
+For Linux:
+```export LD_LIBRARY_PATH=[directory where python is located]``` 
+
+For MacOSX: 
+```export DYLD_LIBRARY_PATH=[directory where python is located]```
+
+For Windows please see this StackOverflow issue for a fix: [fix here](https://stackoverflow.com/questions/79627918/cant-set-python-version-when-running-rust-analyzer-and-pyo3-on-wsl/79627921#79627921)
+
+
+
+
+
+

docs/stylesheets/extra.css

@@ -0,0 +1,38 @@
+@import url('https://fonts.googleapis.com/css2?family=Roboto+Slab:[email protected]&display=swap');
+
+/* Light mode (scheme: default) */
+[data-md-color-scheme="default"] {
+  --md-default-bg-color: #fefcfb;
+  --md-default-fg-color: #1f2128;
+  --md-primary-fg-color: #e45a28;
+  --md-accent-fg-color: #f4a63a;
+}
+
+/* Dark mode (scheme: slate) */
+[data-md-color-scheme="slate"] {
+  --md-default-bg-color: #1f2128;
+  --md-default-fg-color: #fefcfb;
+  --md-primary-fg-color: #F4A63A;
+  --md-accent-fg-color: #E45928;
+}
+
+/* Light mode */
+[data-md-color-scheme="default"] h1,
+[data-md-color-scheme="default"] h1 strong,
+[data-md-color-scheme="default"] h2 {
+  font-family: 'Roboto Slab', sans-serif;
+  font-weight: 400 !important;
+  color: #333333 !important; /* Choose your light mode color */
+}
+
+/* Dark mode */
+[data-md-color-scheme="slate"] h1,
+[data-md-color-scheme="slate"] h1 strong,
+[data-md-color-scheme="slate"] h2 {
+  font-family: 'Roboto Slab', sans-serif;
+  font-weight: 400 !important;
+  color: #FEFCFB !important; /* Your dark mode color */
+}
+.md-typeset h1 strong {
+  font-weight: 600 !important;
+}

docs/usage.md

@@ -0,0 +1,23 @@
+site_name: microBioRust docs
+theme:
+  name: material
+  font:
+     text: "Open Sans"
+  palette:
+     - scheme: default
+       toggle:
+         icon: material/weather-night
+         name: Switch to dark mode
+       primary: custom
+       accent: custom
+     - scheme: slate
+       toggle:
+         icon: material/weather-sunny
+         name: Switch to light mode
+       primary: custom
+       accent: custom
+features:
+  - navigation.tabs
+custom_dir: overrides
+extra_css:
+  - stylesheets/extra.css