sempervent.github.io

Sempervent Landing Page

This repository uses MkDocs with the Material theme to generate documentation.

Quick Start

Local Development

1. Install MkDocs and dependencies:

   pip install mkdocs mkdocs-material

2. Run the development server:

   mkdocs serve

3. View the site at http://127.0.0.1:8000

Building the Site

Validate the project registry and generate portfolio pages, then build:

pip install -r requirements.txt
python scripts/validate_projects.py
python scripts/generate_portfolio.py
mkdocs build --strict

The generated site will be in the site/ directory.

Deployment

The site is automatically deployed to GitHub Pages when changes are pushed to the main branch using GitHub Actions.

The workflow is defined in .github/workflows/deploy-mkdocs.yml.

Project Structure

.
├── docs/                    # Documentation source files
│   ├── index.md            # Home page
│   ├── about.md            # About page
│   ├── getting-started.md  # Getting started guide
│   └── documentation.md    # Documentation page
├── mkdocs.yml              # MkDocs configuration
└── .github/
    └── workflows/
        └── deploy-mkdocs.yml  # GitHub Actions workflow

Customization

Edit the following files to customize your site:

• mkdocs.yml - Site configuration, theme, navigation
• docs/*.md - Page content (Markdown format)

License

See LICENSE file for details.