Overview

Hygraph Docs Starter is a Remix starter kit designed for creating documentation websites with Hygraph. It offers a range of features to enhance the content creation and browsing experience, including rich text editing, table of contents, custom embeds, styling with Tailwind CSS, and SEO support.

Features

• Built with Remix: The starter kit is built on the Remix platform, which provides a powerful and customizable environment for building web applications.
• Embeddable content entries: Hygraph Docs Starter allows you to easily embed content entries using Hygraph, making it simple to include various types of content within your documentation pages.
• Rich Text content editing: With the integration of Hygraph, you can easily create and edit content using a rich text editor, enabling you to format and style your content according to your preferences.
• Table of Contents for docs pages: The starter kit automatically generates a table of contents for your documentation pages, making it easy for users to navigate through different sections of your documentation.
• Render custom embeds using Rich Text Renderer: Hygraph Docs Starter provides a rich text renderer that allows you to render custom embeds within your content, giving you the flexibility to include interactive and dynamic elements.
• Styled using Tailwind CSS: The theme is styled using Tailwind CSS, a popular utility-first CSS framework that offers a wide range of pre-built components and styles, making it easy to create visually appealing and responsive designs.
• Responsive and mobile-friendly: Hygraph Docs Starter is designed to be fully responsive and mobile-friendly, ensuring that your documentation looks and functions well across a variety of devices and screen sizes.
• SEO support: The starter kit includes support for SEO optimization, including Open Graph and Twitter tags, sitemap generation, and other features that help improve the visibility and discoverability of your documentation.
• Preview mode support: Hygraph Docs Starter also provides support for a preview mode, allowing you to preview your documentation before publishing it, ensuring that everything looks perfect before making it available to your users.

Installation

To install and get started with Hygraph Docs Starter, you can follow these steps:

1. Clone the Hygraph project from the official repository.
2. Deploy the cloned project to Vercel using the Vercel CLI or the Vercel GitHub integration.
3. Customize the starter kit according to your needs, including adding your own content, customizing the styling, and configuring the SEO settings.
4. Test and preview your documentation using the preview mode support.
5. Once you are satisfied with everything, publish your documentation website and make it available to your users.

Summary

Hygraph Docs Starter is a powerful and feature-rich Remix starter kit for creating documentation websites with Hygraph. It offers an intuitive and user-friendly environment for content creation and browsing, with features like rich text editing, table of contents generation, custom embeds, responsive design, and SEO support. With Hygraph Docs Starter, you can easily create professional and visually appealing documentation that is optimized for both desktop and mobile devices.