Chaos Laboratory Website

This repository contains the source code for the Chaos Laboratory research group website, built with MkDocs and the Material theme.

🚀 Quick Start

Prerequisites

• Python 3.x
• pip

Installation

Install MkDocs and the Material theme:

pip install mkdocs mkdocs-material markdown_include

Local Development

To run the website locally with live reload:

mkdocs serve

Then open your browser to http://127.0.0.1:8000/

Building the Site

To build the static website:

mkdocs build

The built site will be in the site/ directory.

📁 Site Structure

• docs/ - Contains all the Markdown content for the website
  • index.md - Home page
  • news.md - News about the laboratory
  • team.md - Team members and information
  • research.md - Research projects and areas
  • software.md - Software and tools developed by the lab
  • experiments.md - Experimental facilities
  • publications.md - Research publications
  • blog.md - News, commentary, and articles
  • utilities.md - Small JS applications used for quick calculations
  • assets/ - Images, logos, and other static assets
• mkdocs.yml - MkDocs configuration file
• site/ - Built website (generated, not in git)

✏️ Editing Content

1. Edit the Markdown files in the docs/ directory
2. Preview your changes with mkdocs serve
3. Commit and push your changes

🎨 Customization

The website appearance can be customized by editing mkdocs.yml:

• Colors: Modify the theme.palette section
• Navigation: Update the nav section
• Logo: Change theme.logo path
• Features: Enable/disable features in theme.features

📚 Documentation

• MkDocs Documentation
• Material for MkDocs Documentation

📄 License

This project is licensed under the Apache License 2.0 - see the LICENSE file for details.