Overview

Remix Docs is a documentation site starter built on the Gatsby framework. It offers flexibility in structuring content by using folders and index.mdx files. It generates cached json files for blog posts, docs, and pages, which can be used for various purposes such as sitemap generation. The theme also allows configuration of environment variables and customization of navigation, sidebar links, and search functionality.

Features

• Flexible content structure with folders and index.mdx files
• Generation of cached json files for blog posts, docs, and pages
• Customization of top navigation, sidebar links, and search functionality
• Configuration of environment variables for file system access or GitHub integration

Installation

1. Copy the .env.example file to .env and configure the environment variables according to your needs:

   • SESSION_SECRET: Session Secret used for sessions such as dark mode
   • USE_FILESYSTEM_OR_GITHUB: Specify either fs for file system access or gh for GitHub integration
   • GITHUB_TOKEN: Your Personal access token (only required if using GitHub integration)
   • GITHUB_OWNER: Your GitHub name (only required if using GitHub integration)
   • GITHUB_REPO: Your GitHub repository (only required if using GitHub integration)

2. Install the local dependencies for your project:

npm install

3. Start the Remix development server:

npm run dev

4. Open http://localhost:3000 in your browser and start using Remix Docs.

Summary

Remix Docs is a versatile documentation site starter that provides flexibility in content structure, allowing users to organize their documentation using folders and index.mdx files. It generates cached json files for easy reference and offers customization options for navigation, sidebar links, and search functionality. The theme can be easily installed and configured, making it suitable for a variety of hosting services.