# Basehub > Documentation for Basehub ## Pages - [Basehub Documentation](basehub-documentation.md) - [Introduction](introduction.md): BaseHub is a fast and collaborative Headless CMS. - [Platform Overview](platform-overview.md): Understand the basics of the BaseHub Platform. - [Start Here](start-here.md): Learn how to integrate your Next.js App with BaseHub in a couple of steps. - [Remember to also add this ^ env var in your deployment platform](remember-to-also-add-this-env-var-in-your-deployment-platform.md): In order to generate the BaseHub SDK, we recommend running`basehub dev`in parallel to running the development serve... - [Querying Basics](querying-basics.md): Learn how to build GraphQL queries with the generated client. - [Rendering Rich Text](rendering-rich-text.md): Fragments let you construct sets of fields, and then include them in queries where you need to. - [Environments & Caching](environments-caching.md): Understand the different environments and caching strategies you can leverage to improve your content editing experie... - [MCP](mcp.md): You can use your agent tools provided by our MCP server and connect it to your favorite apps, like Claude and Cursor. - [Agents](agents.md): BaseHub Agents are AI assistants that help with content management, automated workflows, and team collaboration. - [Workflows](workflows.md): Automate content generation across your repository with AI-powered workflows. - [Search](search.md): Learn how to add instant-search into your website. - [Analytics](analytics.md): Learn how to send analytics events from your website. - [Forms](forms.md): The powerful Event block lets you build a form schema from the dashboard, and consume it in code to build complex forms. - [Webhooks](webhooks.md): Learn how to use Webhooks to subscribe to changes that happen within BaseHub. - [Localization](localization.md): Learn how to add localization, or i18n, by using the Variants Block. - [Astro](astro.md): Get started with Astro and BaseHub. - [Remember to also add this ^ env var in your deployment platform](remember-to-also-add-this-env-var-in-your-deployment-platform-2.md): In order to generate the BaseHub SDK, we recommend running`basehub dev`in parallel to running the development serve... - [SvelteKit](sveltekit.md): Get started with SvelteKit and BaseHub. - [Remember to also add this ^ env var in your deployment platform](remember-to-also-add-this-env-var-in-your-deployment-platform-3.md): In order to generate the BaseHub SDK, we recommend running`basehub dev`in parallel to running the development serve... - [Tokens](tokens.md): Learn which tokens exist in BaseHub and what they are for. - [CLI](cli.md): Generates a type-safe client based on your Repo's schema. - [query](query.md): The main method to consume data from your BaseHub repositories. - [mutation](mutation.md): The SDK method to make updates to your repository via the API. - [transaction](transaction.md): The main mutation method, covers most of the modifications that can be done to the schema with three different transa... - [transactionAsync](transactionasync.md): Same as \`transaction\`, but runs async—as a background job. - [getUploadSignedURL](getuploadsignedurl.md): A helper to upload assets to our database. - [transactionStatus](transactionstatus.md): Gets the current transaction status based on its ID. - [](pump.md): A React Server Component that queries BaseHub and can subcribe to real time changes seamlessly. - [](richtext.md): Our official rich text renderer. Supports passing custom handlers for native html elements and BaseHub components. - [](codeblock.md): Easy-to-use component for rendering great code snippets. - [useSearch](usesearch.md): A React hook that instantiates your Search Client. - [](searchboxroot.md): The Search wrapper works as a provider and comes with some optional props that can come in handy. - [](searchboxinput.md): Extends the native HTML Input and consumes the search context in order to fetch hits from the indexed data. - [Hit Components](hit-components.md): Use cases and APIReference for HitList, HitItem, HitSnippet - [](icon.md): A vector renderer for our icon block. Supports passing custom handlers for native svg elements. - [sendEvent](sendevent.md): The events method to send data through BaseHub. Flexible, type-safe and scoped by block. - [getEvents](getevents.md): A query method to retrieve your events stored in BaseHub. - [updateEvent](updateevent.md): Method that allows modifying existing events by their ID. - [deleteEvent](deleteevent.md): Method that removes one or more events by their IDs. - [search](search-2.md): Core method to perform a search query. - [getClientRaw](getclientraw.md): Get the raw search client. - [](toolbar.md): The official BaseHub toolbar to manage draft mode and switch branches in your site previews. - [Version 9](version-9.md): Learn how to upgrade from v8 to v9. - [Version 8](version-8.md): Learn how to upgrade from v7 to v8. - [before](before.md): { - [after](after.md): { - [Explorer](explorer.md): Explore the GraphQL API interactively, thanks to the power of GraphiQL. - [Mutation API Guidelines](mutation-api-guidelines.md): Learn how to create, update, and delete content in BaseHub using the Mutation API with detailed examples and best pra... - [Query API Guidelines](query-api-guidelines.md): Master GraphQL querying in BaseHub with comprehensive examples for layout and primitive blocks, filtering, ordering, ... - [Anatomy of a Block](anatomy-of-a-block.md): You can think of your Repository as a tree of Blocks. Let's explore how this works. - [Root](root.md): The root of the Tree. - [Document](document.md): The most common layout block in BaseHub. Think of them as directories in a file system. - [Component](component.md): The Component block functions as a modular structure within your repository, that can be reused across your schema. - [Instance](instance.md): A modular block that reuses the structure from your Components. - [Collection](collection.md): A powerful list of blocks that can be fully customizable. - [Variants](variants.md): Lets you create variations of a piece of content. Useful for i18n and A/B testing. - [Text](text.md): The default plain text input in BaseHub. Cannot contain rich text formatting. - [Number](number.md): The most primitive number input in BaseHub. Allows integer, float, negative and positive numbers. - [Boolean](boolean.md): A primitive flag input. True or false. - [Date](date.md): A primitive date input, with optional time. - [Rich Text](rich-text.md): A powerful text input that not only supports markdown syntax but also it has the possibility to have many custom comp... - [Media](media.md): All kind of assets in one block. Comes with some constraints that can make your media uploads more reliable. - [Select](select.md): Choose from a pre-defined selection of text options. - [Reference](reference.md): Choose from a constrained list of component types. - [Color](color.md): A primitive color input. Opens a palette, and lets you select every color format. - [OG Image](og-image.md): A lightweight OG Image editor used for social cards. Accepts variables and is fully customizable. - [Event](event.md): A unique block that enables type-safe data submissions - [Workflow](workflow.md): A unique block to automate actions, webhooks and notifications. - [Icon](icon-2.md): Provides seamless rendering of SVG elements in your application. - [Introduction](introduction-2.md): Know more about how templates work in the platform. - [Create Your Own](create-your-own.md): Learn how to create your own template in this short guide. - [Marketing Website Template](marketing-website-template.md): The perfect way to start your next marketing website. - [Documentation Template](documentation-template.md): The template that powers this documentation website. - [Help Center Template](help-center-template.md): The template that powers our own Help Center. Full-text search included. - [Waitlist Template](waitlist-template.md): Minim ipsum veniam elit duis veniam consectetur sit. - [Create a Feedback Form](create-a-feedback-form.md): A simple "Feedback" form using the Event and the Workflow Blocks. - [Create a Newsletter](create-a-newsletter.md): See how you can build a fully-fledged Newsletter using the Event and Workflow Blocks, plus Resend and React Email. - [Create a View Counter](create-a-view-counter.md): Track page views with the Event Block, and display them in your site. - [Create a Form Builder](create-a-form-builder.md): Programmatic pages and forms using the Reference and Event Blocks. - [Custom Components in Rich Text](custom-components-in-rich-text.md): Learn how to use custom components within rich text blocks. - [Simple A/B Testing](simple-ab-testing.md): Learn how to perform simple A/B tests with BaseHub and the Variant Block. - [Docs 19 Documentation](docs-19-documentation.md) - [Introduction](introduction-2.md): BaseHub is a fast and collaborative Headless CMS. - [Platform Overview](platform-overview-2.md): Understand the basics of the BaseHub Platform. - [Start Here](start-here-2.md): Learn how to integrate your Next.js App with BaseHub in a couple of steps. - [Remember to also add this ^ env var in your deployment platform](remember-to-also-add-this-env-var-in-your-deployment-platform-2.md): In order to generate the BaseHub SDK, we recommend running`basehub dev`in parallel to running the development serve... - [Querying Basics](querying-basics-2.md): Learn how to build GraphQL queries with the generated client. - [Rendering Rich Text](rendering-rich-text-2.md): Fragments let you construct sets of fields, and then include them in queries where you need to. - [Environments & Caching](environments-caching-2.md): Understand the different environments and caching strategies you can leverage to improve your content editing experie... - [MCP](mcp-2.md): You can use your agent tools provided by our MCP server and connect it to your favorite apps, like Claude and Cursor. - [Agents](agents-2.md): BaseHub Agents are AI assistants that help with content management, automated workflows, and team collaboration. - [Workflows](workflows-2.md): Automate content generation across your repository with AI-powered workflows. - [Search](search-2.md): Learn how to add instant-search into your website. - [Analytics](analytics-2.md): Learn how to send analytics events from your website. - [Forms](forms-2.md): The powerful Event block lets you build a form schema from the dashboard, and consume it in code to build complex forms. - [Webhooks](webhooks-2.md): Learn how to use Webhooks to subscribe to changes that happen within BaseHub. - [Localization](localization-2.md): Learn how to add localization, or i18n, by using the Variants Block. - [Astro](astro-2.md): Get started with Astro and BaseHub. - [Remember to also add this ^ env var in your deployment platform](remember-to-also-add-this-env-var-in-your-deployment-platform-2-2.md): In order to generate the BaseHub SDK, we recommend running`basehub dev`in parallel to running the development serve... - [SvelteKit](sveltekit-2.md): Get started with SvelteKit and BaseHub. - [Remember to also add this ^ env var in your deployment platform](remember-to-also-add-this-env-var-in-your-deployment-platform-3-2.md): In order to generate the BaseHub SDK, we recommend running`basehub dev`in parallel to running the development serve... - [Tokens](tokens-2.md): Learn which tokens exist in BaseHub and what they are for. - [CLI](cli-2.md): Generates a type-safe client based on your Repo's schema. - [query](query-2.md): The main method to consume data from your BaseHub repositories. - [mutation](mutation-2.md): The SDK method to make updates to your repository via the API. - [transaction](transaction-2.md): The main mutation method, covers most of the modifications that can be done to the schema with three different transa... - [transactionAsync](transactionasync-2.md): Same as \`transaction\`, but runs async—as a background job. - [getUploadSignedURL](getuploadsignedurl-2.md): A helper to upload assets to our database. - [transactionStatus](transactionstatus-2.md): Gets the current transaction status based on its ID. - [](pump-2.md): A React Server Component that queries BaseHub and can subcribe to real time changes seamlessly. - [](richtext-2.md): Our official rich text renderer. Supports passing custom handlers for native html elements and BaseHub components. - [](codeblock-2.md): Easy-to-use component for rendering great code snippets. - [useSearch](usesearch-2.md): A React hook that instantiates your Search Client. - [](searchboxroot-2.md): The Search wrapper works as a provider and comes with some optional props that can come in handy. - [](searchboxinput-2.md): Extends the native HTML Input and consumes the search context in order to fetch hits from the indexed data. - [Hit Components](hit-components-2.md): Use cases and APIReference for HitList, HitItem, HitSnippet - [](icon-2.md): A vector renderer for our icon block. Supports passing custom handlers for native svg elements. - [sendEvent](sendevent-2.md): The events method to send data through BaseHub. Flexible, type-safe and scoped by block. - [getEvents](getevents-2.md): A query method to retrieve your events stored in BaseHub. - [updateEvent](updateevent-2.md): Method that allows modifying existing events by their ID. - [deleteEvent](deleteevent-2.md): Method that removes one or more events by their IDs. - [search](search-2-2.md): Core method to perform a search query. - [getClientRaw](getclientraw-2.md): Get the raw search client. - [](toolbar-2.md): The official BaseHub toolbar to manage draft mode and switch branches in your site previews. - [Version 9](version-9-2.md): Learn how to upgrade from v8 to v9. - [Version 8](version-8-2.md): Learn how to upgrade from v7 to v8. - [before](before-2.md): { - [after](after-2.md): { - [Explorer](explorer-2.md): Explore the GraphQL API interactively, thanks to the power of GraphiQL. - [Mutation API Guidelines](mutation-api-guidelines-2.md): Learn how to create, update, and delete content in BaseHub using the Mutation API with detailed examples and best pra... - [Query API Guidelines](query-api-guidelines-2.md): Master GraphQL querying in BaseHub with comprehensive examples for layout and primitive blocks, filtering, ordering, ... - [Anatomy of a Block](anatomy-of-a-block-2.md): You can think of your Repository as a tree of Blocks. Let's explore how this works. - [Root](root-2.md): The root of the Tree. - [Document](document-2.md): The most common layout block in BaseHub. Think of them as directories in a file system. - [Component](component-2.md): The Component block functions as a modular structure within your repository, that can be reused across your schema. - [Instance](instance-2.md): A modular block that reuses the structure from your Components. - [Collection](collection-2.md): A powerful list of blocks that can be fully customizable. - [Variants](variants-2.md): Lets you create variations of a piece of content. Useful for i18n and A/B testing. - [Text](text-2.md): The default plain text input in BaseHub. Cannot contain rich text formatting. - [Number](number-2.md): The most primitive number input in BaseHub. Allows integer, float, negative and positive numbers. - [Boolean](boolean-2.md): A primitive flag input. True or false. - [Date](date-2.md): A primitive date input, with optional time. - [Rich Text](rich-text-2.md): A powerful text input that not only supports markdown syntax but also it has the possibility to have many custom comp... - [Media](media-2.md): All kind of assets in one block. Comes with some constraints that can make your media uploads more reliable. - [Select](select-2.md): Choose from a pre-defined selection of text options. - [Reference](reference-2.md): Choose from a constrained list of component types. - [Color](color-2.md): A primitive color input. Opens a palette, and lets you select every color format. - [OG Image](og-image-2.md): A lightweight OG Image editor used for social cards. Accepts variables and is fully customizable. - [Event](event-2.md): A unique block that enables type-safe data submissions - [Workflow](workflow-2.md): A unique block to automate actions, webhooks and notifications. - [Icon](icon-2-2.md): Provides seamless rendering of SVG elements in your application. - [Introduction](introduction-2-2.md): Know more about how templates work in the platform. - [Create Your Own](create-your-own-2.md): Learn how to create your own template in this short guide. - [Marketing Website Template](marketing-website-template-2.md): The perfect way to start your next marketing website. - [Documentation Template](documentation-template-2.md): The template that powers this documentation website. - [Help Center Template](help-center-template-2.md): The template that powers our own Help Center. Full-text search included. - [Waitlist Template](waitlist-template-2.md): Minim ipsum veniam elit duis veniam consectetur sit. - [Create a Feedback Form](create-a-feedback-form-2.md): A simple "Feedback" form using the Event and the Workflow Blocks. - [Create a Newsletter](create-a-newsletter-2.md): See how you can build a fully-fledged Newsletter using the Event and Workflow Blocks, plus Resend and React Email. - [Create a View Counter](create-a-view-counter-2.md): Track page views with the Event Block, and display them in your site. - [Create a Form Builder](create-a-form-builder-2.md): Programmatic pages and forms using the Reference and Event Blocks. - [Custom Components in Rich Text](custom-components-in-rich-text-2.md): Learn how to use custom components within rich text blocks. - [Simple A/B Testing](simple-ab-testing-2.md): Learn how to perform simple A/B tests with BaseHub and the Variant Block.