Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/hygraph/docs-starter

Remix starter for creating documentation websites with Hygraph
https://github.com/hygraph/docs-starter

docs graphql hygraph remix tailwindcss typescript vite

Last synced: 30 days ago
JSON representation

Remix starter for creating documentation websites with Hygraph

Host: GitHub
URL: https://github.com/hygraph/docs-starter
Owner: hygraph
License: mit
Created: 2022-01-25T19:15:38.000Z (almost 3 years ago)
Default Branch: main
Last Pushed: 2024-03-27T16:38:57.000Z (9 months ago)
Last Synced: 2024-05-23T06:58:31.923Z (7 months ago)
Topics: docs, graphql, hygraph, remix, tailwindcss, typescript, vite
Language: TypeScript
Homepage: https://docs.withheadlesscms.com
Size: 944 KB
Stars: 52
Watchers: 28
Forks: 11
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

awesome-remix - docs-starter

README

        # 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