SSSStatic Documentation

Installation

  1. Install from PyPI: `pip install sssstatic`
  2. Install from source: `pip install -e .`
  3. Verify installation: `sssstatic --help`

Basic Usage

  1. Create new project: `sssstatic create new`
  2. Edit `_config.yml` with your content
  3. Build the site: `sssstatic build`
  4. Preview locally: `sssstatic serve`
  5. Deploy to any static hosting service

Configuration Structure

  1. `site.name` - Your site's name
  2. `_colorMode` - Choose 'dark' or 'light'
  3. `_title` - Page title (optional)
  4. `_hero_banner` - Hero section with columns
  5. `_card` - Project showcase cards
  6. `_footer` - Custom footer with links
  7. `_page` - Multi-page support

Content Sections

  1. Add any YAML structure for content
  2. Lists become ordered lists in HTML
  3. Nested objects become sections with headings
  4. Use markdown-style links: `text`
  5. Images go in `assets/` folder

Multi Page Feature

  1. Use `_page` component to create additional pages
  2. Each page needs `_name` field for filename
  3. Pages can have their own `_title` and `_footer`
  4. Automatic navigation between pages
  5. Supports both single pages and page arrays