Next.js App Router

This guide assumes you are using the Next.js app router.

Video Guide

Installing dependencies

From within your site's directory, run:

This will ask you a few setup questions. When prompted for the public assets directory, enter: public.

Updating your build scripts

tina init should have updated your package.json scripts.

These should be applied manually if they haven't been set by the CLI.

Starting TinaCMS

You can start TinaCMS with:

We recommend using pnpm.

With TinaCMS running, navigate to http://localhost:3000/admin/index.html.

If you are getting errors when running this command, please see the Common Errors page.

At this point, you should be able to see the TinaCMS admin, select a post, save changes, and see the changes persisted to your local markdown files.

TinaCMS Config file

After running the tina init command a few files were created to get you started as quick as possible. One of these is the tina/config.ts file. This is a required config file that defines all the tina schemas.

It looks like the following:

For a more detailed overview about the config see Content Modeling with TinaCMS

If you've followed this guide using the tina init command, you might have noticed that a content and a pages folder got created:

These can be used as a quick reference but are safe to delete.

Creating a New Post

💡 As defined in the tina/config.ts file we have 1 collection called post which will be picked up by TinaCMS and mapped to what you see in the TinaCMS Admin page.

1.Head over to /admin/index.html

2.Click on Posts

3.Click on Create

4.Enter required fields

5.Save

Now, let's go back and check what was created. You will see a /content folder with your new post saved as a .md file. This path is defined in the tina/config.ts files post collection!

Rendering the Post Collection

Let's start by creating a /posts folder. The page here will list all our posts.

File: app/posts/page.tsx

As you may have noticed this is a Server Rendered page. Depending on how this page is generated can mean Next will either,

• A. Build this as a Dynamic / Server Rendered page
• B. Build this as a Static page.

This is up to you on how you want this page to be rendered.

Rendering a Single Post

To make this work with TinaCMS Visual Editor we are going to break this across 2 components. 1 will build the page at build time. The other will be a client rendered page that can interact and work with TinaCMS.

File: app/posts/[...filename].tsx

Here we are using generateStaticParams to build these pages as SSG. You are free to change this however you like.

Now to make the Visual Editor work, we will create a new "client page":

File: app/posts/[...filename]/client-page.tsx

FAQs

Next Steps

See Also