Chris/homepage

[isoceles]

Description

The following documentation is in docs/theme/README.md

Development Setup

1. Install Node.js dependencies in the docs/theme directory

   npm install

2. Build the theme assets

   npm run build

3. Start the development server

   npm run dev

This will:

• Watch and compile Tailwind CSS
• Watch and bundle JavaScript with esbuild

3. In another terminal, start MkDocs:

# In the project root
mkdocs serve

Homepage-Specific Assets

The Tailwind CSS and JavaScript are only loaded on the homepage. This is controlled in main.html:

{% block extrahead %}
  {{ super() }}
  {% if page.is_homepage or (page.meta and page.meta.template == "home.html") %}
    <link href="{{ 'theme/assets/styles.css'|url }}" rel="stylesheet">
    <script type="module" src="{{ 'theme/assets/dist/home.js'|url }}"></script>
  {% endif %}
{% endblock %}

• styles.css - Tailwind styles for homepage components
• home.js - JavaScript for homepage animations and interactions

Directory Structure

• assets/ - Source files and compiled assets
  • tailwind.css - Tailwind source file (homepage only)
  • home.js - JavaScript source file (homepage only)
  • dist/ - Compiled JavaScript (gitignored)
  • styles.css - Compiled CSS (gitignored)
  • static/ - Static assets like images and animations
• home.html - Homepage template
• main.html - Base template that extends MkDocs Material

Dependencies

• Tailwind CSS for homepage styling
• esbuild for JavaScript bundling
• GSAP for homepage animations
• Rive for interactive animations

Build Process

The theme assets are automatically built when running mkdocs build through the build hook in build.py. This ensures the homepage assets are compiled before the site is built.

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• This change requires a documentation update

How has this change been tested, please provide a testcase or example of how you tested the change?

YOUR_ANSWER

Any specific deployment considerations

For example, documentation changes, usability, usage/costs, secrets, etc.

Docs

• Docs updated? What were the changes:

[CLAassistant]

All committers have signed the CLA.