Skip to content

Create GitHub Pages documentation with Quarto #16

@pjt222

Description

@pjt222

Description

Set up GitHub Pages documentation site using Quarto for the spiralizer package.

Goals

  • Professional documentation site hosted on GitHub Pages
  • Include package documentation, usage examples, and gallery
  • Auto-deploy on push to main branch

Tasks

  • Initialize Quarto project structure (_quarto.yml)
  • Create landing page with app overview
  • Add getting started guide
  • Create gallery page with example spiral configurations
  • Document the mathematical background (Fermat spirals, Voronoi diagrams)
  • Set up GitHub Actions workflow for automatic deployment
  • Configure custom domain (optional)

References

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions