TypedCMS is currently in Early Access. To start using TypedCMS now, please register for our Early Access Program.


Guide Incoming

TypedCMS' use of JSON:API specification compliant APIs make it really easy to integrate into any new or existing Gridsome project.

We're currently developing SDKs and starter kits for all of our supported frameworks. Whilst we do not currently have a kit for Gridsome, it's really easy to get started one of the many freely available and Open Source JSON:API client libraries

Any JSON:API specification compliant library will work with TypedCMS. Our own kits are often built on top of these existing libraries, with the addition of many productivity and quality of life features.

If you'd prefer to use one of our dedicated starter kits, please keep an eye SDKs and Starter Kits on our blog for new releases.

Client Libraries: https://jsonapi.org/implementations/#client-libraries-javascript

Designing a Pages System

The most basic content type for most web projects is pages. In this guide we'll design a simple pages system using TypedCMS blueprints. To follow this guide you'll need a TypedCMS account and a project where you have a team architect or administrator role. Let's get started!

Start with a Blueprint

The first step to creating any content type in TypedCMS is a Blueprint. A blueprint is exactly what it sounds like, a model for your new content. From your projects sidebar, expand Architecture, click Blueprints and then click New Blueprint. Let's name our new blueprint ‘Page’ and then click Create Blueprint.

Creating a Blueprint

Once created, you will be shown your new blueprint's fields. These represent the data that makes up a ‘Page’. By default a new blueprint will include a unique identifier field, a title field and a body field. The ‘Identifier’ is already pre-configured to be auto-generated from the ‘Title’. 

Blueprint Fields

Add Some Fields

This is probably enough for the most basic of pages systems, but we'll add a little extra. Our pages will have a hero image and breadcrumbs. To achieve this we'll need an image field for our hero and we'll use a relationship field to set the parent page for our breadcrumbs.

Let's start with the hero image. Click New Field and select Image from the list of field types presented.

Field Types List
We have loads of field types to choose from!

We'll call this field ‘Hero’ and in the Validation tab, set it as a Required Field. We want our hero image to be constrained to a certain size, so we'll configure this in the Constraints tab. From the Constrain Image Dimensions drop-down select ‘Fixed Width & Height’. You'll now see three more drop-downs, target width, target height and a resize mode. For our hero image we'll use ‘1920’, ‘600’ and ‘Cover’ for a full-width, short hero with auto-cropping. Finish by clicking Create Image Field.

Creating an Image Field

Next let's create a relationship field. Same as before, Click New Field, but this time select One Related Constructs from the list of field types presented. TypedCMS uses the term Constructs to describe things constructed from blueprints, in other words your content.

We'll call this field ‘Parent Page’ and in the set the Blueprint field to associate our ‘Page’ blueprint. We can now select a Title field and an Image field. We'll set these to ‘Title’ and ‘Hero’ respectively. The content of these fields will be shown when associating a parent page - we'll see an example of this later. Click Create One Related Construct Field to finish.

Create a Relational Field

At this point you may want to rearrange your fields into your desired order.

Rearranged Fields

Create a Page

Now that we have a blueprint, we can create our first page. In the project sidebar, Click New Content and you now have a New Page option - click it!

New Content Menu

We'll call this new page ‘About Us’ and throw in some content. Once you're done click Create Page.

Creating an About Us Page

A Collection of Pages

Having saved the page you will be returned to a list containing only your new ‘About Us’ page. This is your Default Collection for the ‘Page’ blueprint; it was created automatically for you. 

Default Collection

It's a bit bland though, so let's make it a bit fancier. In the project sidebar, head to ArchitectureCollections and click the pencil next to your ‘Pages’ collection. As you can see, from here you can add columns and customise sorting and filtering options. 

Let's add some more columns! From the Columns drop-down we'll add our ‘Hero’ and ‘Parent Page’ fields. Finally click Update Collection to save these changes.

Updating a Collection

To return to your ‘Pages’ collection, from the project sidebar navigate through CollectionsPages. You'll now be presented with a much nicer list of pages.

Fancy Pages Collection

Form a Relationship

That's pretty much the basics of pages, but, before we finish up, let's create a relational page. Same a before, click New Page to get started. We'll call this page ‘Our Team’, add some content and set the Parent Page to ‘About Us’. Click Create Page.

Creating an Our Team Page
Complete Pages Collection
The final result!

Done! A simple relational pages system. Using these basic building blocks, you are now free to imagine even more awesome blueprints.

Subscribe to
Our Newsletter

Subscribe to the TypedCMS newsletter for progress reports, feature highlights, special offers and news. We promise not to share your email address, or use it for any purpose other than our newsletter.