# UNDRR Asset Library

> The UNDRR asset library at assets.undrr.org — a versioned, shared collection of web assets for UNDRR web properties, distributed via CDN. Logos, fonts, embeddable widgets, documentation, and standalone data applications.

## Start here

- [Asset library homepage](https://assets.undrr.org/): A short introduction and links to key asset categories
- [Complete sitemap](https://assets.undrr.org/sitemap.html): Searchable file browser; directory links use fragments such as `#mangrove`, `#fonts`, `#logos`, and `#favicons`
- [Developer README](https://assets.undrr.org/README.md): Repository structure, local development, and hosting architecture
- [Contributing](https://assets.undrr.org/CONTRIBUTING.md): Asset conventions, validation, and deployment workflow

Use direct Markdown URLs when retrieving documentation; the homepage does not render the root README. The sitemap is the full inventory, while this file highlights useful entry points.

## Asset usage

Use canonical URLs of the form `https://assets.undrr.org/<path>` without `/static/`. For local previews, replace the origin with `http://localhost:8000`; for testing use `https://test.undrr-asset-library.pages.dev`. The legacy `/testing/static/` path on the production host serves production content.

Preserve published version directories when contributing. Pin consumers to an available version, and read its documentation before choosing file paths. Mangrove uses `mangrove/{version}/` (without a `v` prefix); `mangrove/latest/` is a mutable development build. Other assets follow their own existing directory conventions.

- [Mangrove](https://assets.undrr.org/sitemap.html#mangrove): Shared design styles and components; versioned packages are populated during the build
- [Fonts](https://assets.undrr.org/fonts/README.md): Available typefaces and font-loading guidance
- [Logos](https://assets.undrr.org/sitemap.html#logos): Brand marks and available variants
- [Favicons](https://assets.undrr.org/favicons/README.md): Brand directories, icon sizes, recommended markup, and regeneration instructions

## Documentation

- [Gutenberg Content Guide](https://assets.undrr.org/docs/gutenberg-content-guide/CONTENT_GUIDE.md): Custom blocks, card types, and landing page markup patterns for the UNDRR Drupal Gutenberg block editor
- [Search Widget Reference](https://assets.undrr.org/docs/gutenberg-content-guide/SEARCH_GUIDANCE.md): Full configuration reference for the UNDRR Search Widget block — query syntax, field names, term IDs, and practical examples

## Gutenberg markup samples

Pasteable block markup for the Drupal Gutenberg Code Editor:

- [Core blocks](https://assets.undrr.org/docs/gutenberg-content-guide/samples/gutenberg-samples-core.txt): Headings, paragraphs, buttons, columns
- [Custom blocks](https://assets.undrr.org/docs/gutenberg-content-guide/samples/gutenberg-samples-custom.txt): UNDRR custom block examples
- [Layouts](https://assets.undrr.org/docs/gutenberg-content-guide/samples/gutenberg-samples-layouts.txt): Page skeletons and layout patterns
- [Views blocks](https://assets.undrr.org/docs/gutenberg-content-guide/samples/gutenberg-samples-views.txt): Highlight cards

## Embeddable widgets

- [SFM Quick Facts Widget](https://assets.undrr.org/projects/sfm-quick-facts/README.md): Sendai Framework Monitor quick facts widget, embeddable in Drupal and other sites
- [Cookie Banner](https://assets.undrr.org/cookie-banner/v1/README.md): Cookie consent configuration and integration using vanilla-cookieconsent

## Data

- [Country Pages Data](https://assets.undrr.org/projects/pw-country-pages/data/README.md): Per-country disaster risk data (JSON), versioned and segmented by ISO country code
- [Hazard Information Profiles](https://assets.undrr.org/projects/hips/README.md): Interactive tools for UNDRR Hazard Information Profiles (HIPs)

## Projects overview

- [All projects](https://assets.undrr.org/projects/README.md): Index of standalone applications and data resources in this asset library

## Editing this repository

Edit `index.html` for the landing page, `scripts/readme-template.html` for generated README viewers, and `scripts/sitemap-template.html` for the file browser. `npm run deploy-index` preserves the root homepage and app-owned indexes. Regenerate documentation pages and the sitemap with the scripts described in the developer README instead of editing generated files.

Keep this file focused on guidance and entry points; maintain detailed inventories in the sitemap and category READMEs.