Skip to content

Repository files navigation

Dokumentace AMČR API

SWH

Repozitář obsahuje zdrojové soubory dokumentace API systému AMČR (Archeologická mapa České republiky), součásti AIS CR.
Web je publikován na adrese api.aiscr.cz.

ENGLISH VERSION HERE


O projektu

AMČR API poskytuje strojově čitelný přístup k datům Archeologické mapy České republiky.
Dokumentace pokrývá tři hlavní rozhraní:

  • Auth API — autentizace a správa přístupu
  • File API — přístup k souborům a dokumentům Digitálního archivu
  • OAI-PMH — protokol pro sklízení metadat (Open Archives Initiative Protocol for Metadata Harvesting)

AMČR API je součástí ekosystému AIS CR, který provozuje Archeologický ústav AV ČR, Praha, v. v. i. (ARÚP) a Archeologický ústav AV ČR, Brno, v. v. i. (ARÚB).


Technický stack

Vrstva Technologie
Dokumentační framework Quarto
Scripty / build JavaScript, Python
Lua filtry Quarto Lua filters
Styling SCSS, CSS (vlastní téma theme.scss, museo.css)
Quarto extensions quarto-ext/fontawesome
Publikace GitHub Pages (vlastní doména api.aiscr.cz)
CI/CD GitHub Actions
Citace CITATION.cff, Software Heritage

Struktura repozitáře

aiscr-api-home/
├── _quarto.yml            # Hlavní konfigurace Quarto projektu
├── index.qmd              # Úvodní stránka
├── 404.qmd                # Stránka pro nenalezené URL
├── theme.scss             # Vlastní Bootstrap/Quarto SCSS téma
├── museo.css              # Font Museo
│
├── about/                 # Informace o API a dokumentaci
├── auth-api/              # Dokumentace Auth API (autentizace)
├── file-api/              # Dokumentace File API (soubory a dokumenty)
├── oai-pmh/               # Dokumentace OAI-PMH protokolu
├── changelogs/            # Changelog API a dokumentace
├── figs/                  # Obrázky a diagramy
├── fonts/                 # Vlastní fonty
│
├── _extensions/           # Quarto extensions (fontawesome)
├── _freeze/               # Freeze soubory (reproducibilita)
├── .github/               # GitHub Actions workflows
│
├── CITATION.cff           # Citační metadata
├── CODEOWNERS             # Vlastníci kódu
├── AGENTS.md              # Pokyny pro AI agenty
└── .agents/           # AI review infrastruktura

Lokální spuštění

Předpoklady

  • Quarto CLI ≥ 1.4
  • Node.js (pro případné build skripty)
  • Python ≥ 3.10 (pro případné pomocné skripty)

Náhled dokumentace

quarto preview

Sestavení (render)

quarto render

Výstup je generován do složky _site/.


Přispívání

Viz CONTRIBUTING.md.


Citace

Pokud tuto dokumentaci citujete, použijte prosím metadata v souboru CITATION.cff.


Kontakt


Související repozitáře

About

Home page of AMCR API, part of Archaeological Information System of the Czech Republic (AIS CR)

Resources

Contributing

Stars

2 stars

Watchers

4 watching

Forks

Releases

Used by

Contributors

Languages