RemixViteReactDocumentationStarter

docs-starter — Remix Documentation Template

By hygraph

A Remix-based documentation site starter with content from the Hygraph headless CMS, styled with Tailwind CSS and supporting preview mode.

Explore the design

Compare the page layouts and mobile experience. Open any screenshot for a closer look.

2 previews
Desktop homepage1 / 2
Desktop captureTop of page

Actual screenshot captured by the server browser.

All pages & views 2

Screenshots show visual appearance; interactive behavior may differ.

Recorded 2026-10-07View source

What stands out

A quick read of the recorded project description.

01

A documentation site starter built with Remix

02

Content comes from the Hygraph headless CMS, supporting rich text editing

03

Documentation pages automatically generate a table of contents

04

Custom embedded content can be rendered through a rich text renderer

05

Styled with Tailwind CSS, responsive and mobile-friendly

06

Includes SEO output such as Open Graph, Twitter tags, and a sitemap, and supports preview mode

Template Details

This is a documentation website starter built with Remix, with content sourced from the Hygraph headless CMS. The repository provides an entry point for cloning a Hygraph project and deploying to Vercel, while the complete onboarding steps are placed in the documentation site included with the project.

Functionally, it supports editing rich text content in Hygraph, generating a table of contents on documentation pages, rendering custom embedded content through a rich text renderer, and includes a preview mode. Styling uses Tailwind CSS, pages are responsive, and it includes SEO-related output such as Open Graph, Twitter tags, and a sitemap.

Before use, environment variables such as the Hygraph endpoint and tokens (HYGRAPH_ENDPOINT, HYGRAPH_DEV_TOKEN, HYGRAPH_PROD_TOKEN, PREVIEW_SECRET) must be prepared, so site content is not stored in the repository but depends on an external CMS service. The code is MIT licensed and can be used, modified, and distributed for free; third-party assets such as demo images, fonts, and icons require separate license verification, and external services such as domains and hosting may incur costs.

RemixViteDocumentationStarter

Is it right for your project?

Use Cases

  • Building a documentation site for a product with content managed by Hygraph
  • Editing rich text in Hygraph and publishing to a Remix frontend
  • Documentation pages that need table of contents navigation and custom embedded content
  • Needing preview mode to review content before publishing

Suitable For

  • Teams using Hygraph as a content source
  • Developers familiar with Remix and Tailwind CSS
  • Projects that need a documentation site with SEO tags and a sitemap
  • Developers who want to modify the code based on the MIT license

Getting started & customization

Use these recorded setup notes alongside the repository instructions for your chosen version.

  1. 1

    You can first clone the official Hygraph project, then deploy to Vercel

  2. 2

    Environment variables HYGRAPH_ENDPOINT, HYGRAPH_DEV_TOKEN, HYGRAPH_PROD_TOKEN, PREVIEW_SECRET need to be configured

  3. 3

    Complete onboarding steps are in the project documentation site docs.withheadlesscms.com/getting-started

  4. 4

    Content depends on the external Hygraph service; the repository itself does not contain documentation data

  5. 5

    Third-party assets and external services need separate license and cost verification

Read repository instructions

License & source material

Usage conditions & limitations

Free to use · keep license notice

This entry covers the free version of the public repository under the MIT license; the free scope is the code of this version and does not mean external services or third-party assets are free.

Must comply with when using

  • Free use, modification, commercial use, and distribution of this version's code are allowed.
  • When distributing copies or substantial portions of the code, retain the original author's copyright notice and the full MIT license notice.
  • The code is provided as is; warranties and limitations of liability are governed by the original license and applicable law.

Additional costs & items to verify

  • Demo images, fonts, icons, and other third-party assets need to be checked under their respective licenses and cannot be judged solely by the code's MIT license.
  • External services such as domains, hosting, databases, payments, or AI may incur additional charges.
  • Using this template requires first cloning the official Hygraph project and deploying to Vercel; site content depends on the Hygraph cloud service rather than data included in the repository.
  • Before running, environment variables such as HYGRAPH_ENDPOINT, HYGRAPH_DEV_TOKEN, PREVIEW_SECRET, HYGRAPH_PROD_TOKEN must be configured, meaning a Hygraph account and API tokens are required.
  • Complete onboarding steps are located on the external documentation site docs.withheadlesscms.com, and accessing that external service is required to obtain configuration instructions.
View Original Text Basis

Permission is hereby granted, free of charge

Original License Text

The simplest way to get started is by cloning the Hygraph project and deploying it to Vercel.

Original README

env=HYGRAPH_ENDPOINT,HYGRAPH_DEV_TOKEN,PREVIEW_SECRET,HYGRAPH_PROD_TOKEN

Original README

For the complete getting started guide, check our [documentation](https://docs.withheadlesscms.com/getting-started).

Original README
https://github.com/hygraph/docs-starter/blob/main/LICENSE.mdhttps://github.com/hygraph/docs-starter/blob/main/README.md

Compiled by DeepSeek based on repository license and README ·2026-10-07. Results only cover the materials read; dependencies, images, fonts, and subsequent term changes are subject to their respective original texts.

Project checks & description sources

Template Information

Source platforms
GitHub
Documentation and maintenance reference score
More documented · 77 / 100
Technologies
Remix · Vite · React
Website type
Documentation · Starter
How this score is calculated

Our heuristic uses license records (up to 30), a demo link (12), a preview (10), stars (15), recorded maintenance (15), description completeness (8), feature records (5) and classification data (5). It is not a code, security or performance test, or a Google score. A link does not establish tested functionality.

What to verify for this project

Repository update recorded
2024-03-27
Screenshot last checked
2026-10-07

A demo link is listed. Check it with your own content and viewport sizes; its presence does not confirm that forms, authentication or payments work.

The catalog identifies Remix as the primary stack. Check the actual dependency manifest and lockfile for versions and hosting requirements. These notes use recorded metadata, not a code audit or a deployment test.

Use a selection guide →

How this description was prepared

AI-assisted description based on catalog records and repository material. Repository authors are not automatically the reviewers of this description.

Review declaration: [email protected] · 2026-10-08

Inspect the recorded source material

SHA-256: 8ab75e2af15547f22b4e583993881c055836a8dc5ca31468a66765c55e7ad64a

2026-10-07T22:21:09.194Z

Source file / repository
# docs-starter

> A [Remix](https://remix.run/) starter for creating a documentation websites with [Hygraph](https://hygraph.com).

![Hygraph Docs Starter](https://github.com/hygraph/docs-starter/assets/26466516/778a8b02-0dce-4bf6-bb31-d9739375d25e)

## Getting Started

The simplest way to get started is by cloning the Hygraph project and deploying it to Vercel.

[![Clone project](https://hygraph.com/button)](https://app.hygraph.com/clone/1bc5b8c08db04e629d98dc54d6bfe5e5) [![Deploy with Vercel](https://vercel.com/button)](https://vercel.com/new/clone?repository-url=https%3A%2F%2Fgithub.com%2FHygraph%2Fdocs-starter&env=HYGRAPH_ENDPOINT,HYGRAPH_DEV_TOKEN,PREVIEW_SECRET,HYGRAPH_PROD_TOKEN&envDescription=The%20Enviroment%20variables%20for%20the%20project&envLink=https%3A%2F%2Fdocs.withheadlesscms.com%2Fgetting-started&demo-title=Documentation%20Starter%20Demo&demo-description=See%20the%20docs%20starter%20in%20action!&demo-url=https%3A%2F%2Fdocs.withheadlesscms.com&demo-image=https%3A%2F%2Fgithub.com%2Fhygraph%2Fdocs-starter%2Fassets%2F26466516%2F778a8b02-0dce-4bf6-bb31-d9739375d25e)

For the complete getting started guide, check our [documentation](https://docs.withheadlesscms.com/getting-started).

## Features

- Built with Remix
- Embeddable content entries with Hygraph
- Rich Text content editing
- Table of Contents for docs pages
- Render custom embeds using Rich Text Renderer
- Styled using Tailwind CSS
- Responsive and mobile-friendly
- SEO support (Open Graph & Twitter tags, sitemap, etc.)
- Preview mode support
Report a correction

Explore similar templates

Compare previews and descriptions within the same stack and category.

medusa2-starter

medusa2-starter

A Turborepo monorepo starter that pairs a Medusa2 backend with a Remix frontend, including a Coffee Roast themed storefront, Stripe payments, and Express Checkout setup notes. It supports unlimited products, collections, categories, and tags, and uses TypeScript with Biome.

Remix · E-commerce

remix-knowledge-base

remix-knowledge-base

A Remix-based knowledge base starter kit with Tailwind CSS and Prisma, offering Tiptap WYSIWYG and Monaco Markdown editors, multiple knowledge bases, multi-language support, drafts, SEO settings, simple statistics, and Supabase image storage.

Remix · Starter

directed-stack

directed-stack

Directed Stack is an MIT-licensed Remix starter that uses Directus as a headless CMS for authentication, blog, pages, and backend storage. It includes cookie-session email/password auth, an /api/healthcheck endpoint, Tailwind, Markdoc rendering with custom components, Prettier, ESLint, and TypeScript.

Remix · Starter

remix-shadcn-docs

remix-shadcn-docs

A Remix and Shadcn UI starter template for documentation and blogs, with TypeScript, Tailwind CSS, Markdown content directories, and built-in i18n.

Remix · Documentation

remix-wasmer-starter

remix-wasmer-starter

A Remix-based static site starter for Wasmer Edge. It uses getStaticPaths() to generate the root path at build time, sets serverBuildTarget to "wasmer" in remix.config.js, and outputs static assets to build/client for direct static hosting.

Remix · Starter

tailwind-remix-starter

tailwind-remix-starter

A free, MIT-licensed Remix starter maintained by themesberg that combines Remix, React, Tailwind CSS, and Flowbite React into a ready-to-develop project skeleton.

Remix · Starter