Synced Blocks

Synced blocks enable you to create a single piece of content (single-sourcing) that can be reused across multiple pages as often as necessary. When you modify a synced block, those changes are automatically reflected across all pages where the block is utilised, ensuring consistency and efficiency in your content management.

Reuse Content - Creating Synced Blocks

To create a synced block:

• Type /

• Choose Synced Block .

• Choose Create New Synced Block. A form will show.

• In the form, you need to define:

  • ID: An identifier for the synced block. Once saved, the ID cannot be modified. This ID will be visible in your exports. For example, if you are creating a guide on installing Docker, your ID could be docker-installation.
  • Title: Select a title that accurately represents the content, making it easy for your teammates to locate. Note that the title is editable and can be changed later.
  • The contents: Utilise the editor to compose the contents of the synced block. These contents are flexible and can be modified later. Feel free to include any blocks that are already supported in DeveloperHub.

Reuse a Synced Block

To reuse a synced block:

• Start a new line (using ↵ )
• Click on to open the blocks menu.
• Choose Synced Block .
• Choose Choose Existing Synced Block.
• Select the synced block you want to reuse, or search for it first.
• Click on Choose.

Identifying a Synced Block

When you're in the editor, synced blocks will have a Synced badge at the top right. Once you hover on a synced block, an orange dotted line will show what contents are exactly in the synced block.

Editing a Synced Block

Modifying a synced block changes its contents in all instances it is used. This operation can only be done by Publishers.

To edit a synced block:

• Go to a page that has the synced block to be edited.
• Click on the icon at the top right of the synced block.
• A form will appear where you can modify the title and contents.
• Make the changes and click Save.

Deleting/Archiving a Synced Block

Once a synced block is added to your project, it can never be deleted but it can be archived. Archiving a synced block does not remove its instances from any page it is added to, but it only removes it from the list of synced blocks that your teammates can choose.

To archive a synced block:

• Start a new line (using ↵ )
• Click on to open the blocks menu.
• Choose Synced Block .
• Choose Choose Existing Synced Block.
• Find the synced block to archive, and hit the icon next to it.
• Confirm your choice.

Using Page Links in Synced Blocks

You can link to pages inside a synced block. However, there are limitations to its use.