Documentation site for ARCAkit, built with Ruby on Rails. Renders Markdown guides from a GitHub repository with no database required.
Guides are Markdown files stored in app/content/guides/ — either locally or in a GitHub repository. The app fetches and renders them at request time, with caching.
Each guide is a .md file with YAML frontmatter:
---
title: Getting Started
description: A brief description shown in the index.
section: Introduction
position: 1
---
Your content here.section— groups guides in the index dropdownposition— sort order within the section
- Ruby 4.0.1
- Rails 8.1
bundle install
bin/rails serverAdd .md files to app/content/guides/ and they'll appear automatically.
Set GITHUB_REPO to load guides from a GitHub repository instead of local files:
GITHUB_REPO=arcakit/arcakit-docs bin/rails serverThe app reads from app/content/guides/ in that repo. For private repos, also set GITHUB_TOKEN.
Guide content is cached for 5 minutes by default. Override with GUIDE_CACHE_TTL (in seconds).
Deployed via Kamal to guides.arcakit.dev.
kamal deploy