diff --git a/projects/mkdocs-love.md b/projects/mkdocs-love.md index c65923b..6369a6c 100644 --- a/projects/mkdocs-love.md +++ b/projects/mkdocs-love.md @@ -1,3 +1,81 @@ +### Steps to Apply Changes and Build + +1. Ensure all necessary plugins are installed: + +```sh +pip install -r requirements.txt +``` + +2. Build and serve the MkDocs site: + +```sh +mkdocs build +mkdocs serve --dev-addr 192.168.2.219:8000 +``` + +### Combined Steps + +Here are the combined steps to set up, build, and serve the MkDocs site: + +```sh +# Step 1: Create the conda environment +conda env create -f environment.yml + +# Step 2: Activate the environment +conda activate mkdocs-env + +# Step 3: Install additional Python packages +pip install -r requirements.txt + +# Step 4: Initialize a Git repository (if not already done) +git init +git add . +git commit -m "Initial commit" + +# Step 5: Ensure mkdocs.yml is correctly formatted + +# Step 6: Build the MkDocs site +mkdocs build + +# Step 7: Serve the MkDocs site headlessly on the specified IP address +mkdocs serve --dev-addr 192.168.2.219:8000 + +# Step 8: Deploy the MkDocs site (e.g., to GitHub Pages) +mkdocs gh-deploy + +# Step 9: Deactivate the environment +conda deactivate + +# Step 10: Optionally remove the environment if no longer needed +conda env remove -n mkdocs-env +``` + +--- + +# Create the conda environment using environment.yml +conda env create -f environment.yml + +# Activate the new environment +conda activate mkdocs-env + +# Install additional packages from requirements.txt +pip install -r requirements.txt + +# Build the MkDocs site +mkdocs build + +# Serve the MkDocs site headlessly on the specified IP address +mkdocs serve --dev-addr 192.168.2.219:8000 + +# Deploy the MkDocs site (e.g., to GitHub Pages) +mkdocs gh-deploy + +# Deactivate the conda environment +conda deactivate + +# Optionally remove the environment if no longer needed +conda env remove -n mkdocs-env + Let's refactor the project to include the MathJax and Mermaid.js integrations as well as the improved configurations for enhanced mathematical rendering and dynamic visualizations. ### Project Structure