Skip to content

Reference

The reference documentation is broken up into 6 sections. Select the section you want from the sidebar.

Server-side

This section contains information about module configuration functions and commmon options, server-side events emitted by apostrophe modules, and query builders for interogatting the database.

Field types

This sections contains details about all of the built-in schema fields available for use in your project modules.

Template tags

This section contains information about the custom Nunjuck template tags for retrieving and rendering data to the front-end pages.

Core Modules

This section contains information about the majority of the Apostrophe core modules, including relevent methods and command line tasks.

REST API Routes

This section contains information about using the API to request piece and page type documents. This section is a must read for anyone wanting to use Apostrophe as a headless CMS.

Glossary

This section defines terms used throughout our documentation as they apply to Apostrophe.