Skip to content

Getting Started

What is Astro Theme Provider?

Astro Theme Provider is an alternative method of authoring themes for Astro. Author themes similar to a normal Astro project and export your work as an integration for others to use. Check out this blog post for more information: Introducing: Astro Theme Provider

How to get started

  1. Clone the theme template

    Terminal window
    git clone https://github.com/astrolicious/astro-theme-provider-template.git my-theme
  2. Navigate to the directory and install dependencies (pnpm required)

    Terminal window
    cd my-theme
    pnpm i
  3. Run the playground to generate types for the theme and preview any changes

    Terminal window
    pnpm playground:dev
  4. Explore! Learn how Astro Theme provider works by navigating around the theme and reading the docs:

    • Directorypackage/
      • Directorypublic/
      • Directorysrc/
        • Directoryassets/
        • Directorycomponents/
        • Directorylayouts/
        • Directorypages/
        • Directorystyles/
      • index.ts
      • package.json
      • README.md
    • Directoryplayground/
      • Directorysrc/
      • astro.config.mjs
      • package.json
      • tsconfig.json