Discovery & SEO Services
Effective Search Engine Optimization (SEO) and content discoverability are critical for any web application's success. They ensure that your blocklet can be easily found, understood, and shared by users and other services across the internet. Blocklet Service provides a suite of tools designed to enhance your application's visibility on search engines, social media platforms, and other websites.
This guide provides an overview of the key discovery and SEO services available for your blocklet. By leveraging these services, you can improve how your content is presented and integrated across the web, leading to better engagement and a wider reach.
Key Services#
The following services are automatically enabled and configured to help improve your blocklet's discoverability.
Open Graph Service#
The Open Graph service dynamically generates social media preview images for your blocklet's pages. When a user shares a link to your application on platforms like Facebook, Twitter, or Slack, a rich preview card with a title, description, and a custom image is displayed. This is crucial for increasing click-through rates and ensuring brand consistency.
The service offers several templates to control the appearance of these images, allowing you to include titles, descriptions, logos, and other branding elements.
For detailed instructions on implementation and customization, please refer to the Open Graph Guide.
OpenEmbed Service#
The OpenEmbed service allows parts of your blocklet to be easily embedded into other websites, similar to embedding a YouTube video or a Tweet. It follows the oEmbed specification, a standard format for allowing an embedded representation of a URL on third-party sites. By exposing oEmbed-compatible endpoints, you make it simple for other content creators to integrate and showcase your blocklet's features within their own platforms.
Each component within your blocklet can provide its own openembed.json file, which is automatically aggregated into a single, site-wide discovery endpoint.
To learn how to configure your components for embedding, see the OpenEmbed Guide.
OpenAPI Specification#
For blocklets that expose APIs, the service can automatically discover and merge OpenAPI specification files (openapi.yml or openapi.json) from your blocklet and its components. This creates a unified API definition that can be used by developer tools, API clients, and discovery services to understand and interact with your blocklet's programmatic interfaces. This enhances the developer experience and promotes integration.
Sitemap and Robots.txt#
Blocklet Service automatically generates and serves sitemap.xml and robots.txt files for your application.
- sitemap.xml: This file lists the important pages on your website, helping search engine crawlers like Google find and index your content more efficiently.
- robots.txt: This file instructs web crawlers on which pages or files they can or cannot request from your site.
These files are managed by the system to follow best practices for SEO and require no manual configuration from the developer.
Summary#
By utilizing the Discovery and SEO services provided by Blocklet Service, you can significantly improve how your application is perceived and indexed by external platforms. These tools are designed to work with minimal configuration while offering powerful customization options for those who need them. We encourage you to explore the detailed guides for each service to make the most of what they offer.