concepts > documents

Creating a Document

Last updated Invalid Date

Contents

There are two possibilities for creating Documents:

  • Create a new Document.
  • Use an existing Template to create a Document.

Creating a new Document

This section shows you how to create a Document with a video walkthrough or step-by-step with written instructions and screenshots.

Creating a Document video

Step-by-step

When you create a new blank Document, you start without specifying a Template. However, Tipe will prompt you to create one when you Save. This is the same process as creating a Template.

In the Folders section of the Tipe dashboard, click the New Document icon:

New Document icon

In the modal that appears, choose Blank Document.

Create New Document Screenshot

In your new blank Document, name it by clicking on New Document. To add elements to your Document, click on plus icon.

New Document Screenshot

Choose the kind of Block you'd like to add to your Document.

Add a Block Dialog

Enter a name for the block and you'll see that the API ID is automatically generated from the name you type. The Description is for anyone who might edit this Document in the future.

New Block Details

After you click Create, the new Block will appear in your Document.

New Block

If you'd like to rename the Block or change its description, click on either field to edit. When you rename a Block, the API ID updates automatically. To delete a Block, click the red Delete that appears on hover to the top right of the Block.

If you haven't used a Template to create a Document, but try to Save it, Tipe will prompt you to pair your Document with a Template. Enter a Name for the Template that to associate with this Document.

Save Template Prompt

Use an existing Template to create a Document

This section shows you how to create a Document with a Template with a video walkthrough or step-by-step with written instructions and screenshots.

Creating a Document with a Template video

Step-by-step creation of a Document with a Template

To use an existing Template to create a Document, simply choose a Template instead of a New Blank Document in the New Document Dialog:

New Document from Template

The rest of the steps are the same.

Note: When you change something in a Document, such as add or remove a Block, it changes the associated Template, thereby changing all of the other Documents that use that Template.

Creating a Document within the Templates section

Alternatively, you can create a Document from the Templates section of the Tipe dashboard. Click on the Templates icon.

Templates Icon Screenshot

Next, choose the Template you want to use for your new Document. Simply clicking it will create the New Document. Be sure to save.

Watch the following video to see a Document created in the Templates section.

The Document API

The Document API gives you an easy way to connect your app to Tipe and shows you the API so you know exactly what to query. On the left, copy the code example and paste it into your app. The right-hand side changes to reflect edits in the Document and its Blocks. When you first go to this tab, the right side is blank. Click Run Rest or Run GraphQL to see the API for the Document.

Doc API Example

In the REST API or GraphQL output, you can see things such as whether or not the page is published and all of the blocks this document contains along with their pertinent metadata.

Your API Keys

At the top of the Example Code, you'll see YOUR_ORG_SECRET_KEY and YOUR_API_KEY, which are necessary for connecting to Tipe. While these are here in the Example Code for context, you can also find them in the API Keys section of the Tipe dashboard. Don't push them up to GitHub or otherwise make them public, they're sensitive and need to be kept private.

Video demo of API tabs

The following video shows you how to generate GraphQL and REST in a Document's API tab:

Deleting a Document

To delete a Document, click on the Options icon Options Icon Screenshot and select Delete.

Delete Document Menu Item Screenshot

If you prefer to see these steps in action, check out the following video, which shows the same steps:


Go further

Blocks

Use Blocks to get content into your Documents.


Publishing

Publish your Documents to help streamline content delivery.