loading...
Cover image for Visual Open Authoring with Next.js & TinaCMS

Visual Open Authoring with Next.js & TinaCMS

scottgallant profile image scottgallant Originally published at tinacms.org ・3 min read

We're focused on improving the independent web as a whole. We want to craft tools that help people build better sites and create better content.

In line with this mission, we sought to create something we call Visual Open Authoring ✍️. The open authoring concept was originally pioneered by Netlify CMS this past summer and involves opening up your website's CMS to accept content-related contributions from anyone. Using Tina, we were able to take this a step further, establishing the editing context on the page itself.

Add an "Edit Mode" to Your Site

Picture this: on your website, there's an "Edit this page on GitHub" link — familiar enough. But imagine that when you click it, instead of kicking you over to GitHub, the site itself becomes editable, like a Google Doc.

The experience should feel familiar for anyone that has used a word processor or site builder. You navigate to the page you want to change, click “Edit”, make updates in a WYSIWYG, and then submit your changes. That’s it 🧞‍♂️.

TinaCMS Visual Open Authoring

What's under the hood?

The scaffolding underneath Visual Open Authoring is a Git-based workflow. Triggering "Edit Mode" creates a new fork to track and commit changes on. When content updates are ready, the editor can make a pull request. The site owner can then review the work before making it live.

Currently, this requires a GitHub account and some knowledge of Git workflows, making Open Authoring ideal for developer-centric sites (docs, wikis, etc). Soon, we will be opening up Tina Teams so people without GitHub accounts can easily edit in real-time too.

We are currently prototyping this on our own site. In the coming weeks, the APIs for integrating Visual Open Authoring with Tina will become available. In the meantime, go to tinacms.org/blog/introducing-visual-open-authoring and click the edit button at the top of the page to try it out. Feel free to reference this site’s source code to see how it works.

edit

Using Next.js to Enable "Edit-mode"

A new feature announced in Next.js 9.3 has been instrumental to providing the ideal experience for Visual Open Authoring. The preview mode capability allows us to host a website that is fully static by default, but switches to a dynamic mode that runs server code for users that have a special "preview" cookie set. What we refer to as "Edit Mode" for Visual Open Authoring is the same as this Next.js "Preview Mode".

The ability for a website to run statically by default, and then "wake up" into a dynamic web application in response to specific user actions, is revolutionary. It significantly simplifies the concerns of operating an editing environment with Tina. With this workflow, we don't have to host a separate Cloud Editing Environmentthe live site is the editing environment! And thanks to Git and our fork-based workflow, we can edit content from the production website worry-free.

Crowdsourcing your content

Visual Open Authoring is a unique, low-friction approach to website editing. Thanks to the clever Next.js preview mode, Tina's content flexibility, and the seamless Inline Editing experience, we're ready for a digital content revolution.

What if it were effortless to fix a spelling error on the New York Times? Imagine contributing to the ReactJS documentation in an instant.

The web is all about community, crowdsourcing, and the power of many perspectives. The easier it is to make content contributions, the more viewpoints we incorporate. The less context switching, the more space for creative expression of ideas.

Let's democratize content and strengthen the independent web.

Posted on Oct 21 '19 by:

scottgallant profile

scottgallant

@scottgallant

Co-founder and CEO of Forestry.io and TinaCMS. Totally obsessed with the JAMstack, web development, and content editing.

Discussion

markdown guide
 

Love the idea and the description of how it is engineered! It sounds like what I hoped grav would be.