Allmaps Slides

Application to create map stories using MapLibre, Protomaps and Allmaps.

Inspired by

• Reuzenarbeid
• City Atlas
• Interactive Storytelling with MapLibre

Developing

This repository is a pnpm workspace:

• apps/slides contains the SvelteKit application.
• content/gravity-at-sea is the @allmaps/gravity-at-sea workspace package. It exports the Gravity at Sea markdown, config, and assets.
• packages/cli validates content and starts/builds the app.
• packages/slides-content is the stable app import target. The CLI aliases it to the selected content package when it starts the app.

The content package's slides.config.yml tells the CLI which public settings to pass to SvelteKit. The content itself is selected by package name, for example @allmaps/gravity-at-sea.

Install dependencies with pnpm install, start a development server:

pnpm run dev

# or start the server and open the app in a new browser tab
pnpm run dev -- --open

During development, the app imports content directly from @allmaps/slides-content, a stable package name. The CLI resolves the selected content package, aliases @allmaps/slides-content to that package's entry point, watches the selected package root, and reports validation errors. It no longer copies markdown or assets into the app.

The content package has a small entry point:

content/
  gravity-at-sea/
    package.json
    index.ts
    slides.config.yml
    project.yml
    slideshows/
    assets/

content/gravity-at-sea/index.ts exports Vite glob imports for project config, markdown slides, and project assets. Asset paths in markdown/frontmatter are resolved relative to the current project folder.

The content entry point also supports the older nested-project shape, where project folders live below the package root:

content-package/
  package.json
  index.ts
  some-project/
    project.yml
    slideshows/
    assets/

Building

To create a production version of your app:

pnpm run build

You can preview the production build with pnpm run preview.

Use another config file by calling the CLI directly:

pnpm exec slides build @allmaps/gravity-at-sea --config content/gravity-at-sea/slides.production.yml

Routing

By default, the root route shows a project overview, project main slideshows are served at /:project, and subslideshows are served at /:project/:slideshow.

For a build with exactly one project, set routing.singleProjectRoot: true in the config to publish that project at the root instead. In that mode, the main slideshow is served at / and subslideshows are served at /:slideshow.

Config

content/gravity-at-sea/slides.config.yml supports environment placeholders, which is useful for GitHub Pages base paths and public API keys:

site:
  basePath: ${SLIDES_BASE_PATH}
  publicUrl: ${SLIDES_PUBLIC_URL}
routing:
  singleProjectRoot: false
protomaps:
  key: ${PUBLIC_PROTOMAPS_KEY}

Generated folders such as apps/slides/build and SvelteKit/Vite caches are ignored by git.