Rails CTO Site
Static marketing/docs site built with VitePress.
Okay, so we're repurposing RailsCTO (this project) to be home page and help documentation for our RailsCTO skills plugin (https://github.com/mattsears/rails-cto) project. Also cloned locally here @/Users/matt/Workspace/active/rails-cto
This will be a site that allows users to understand what the skills projects is for and also provide documentation about:
- Overview
- How to install
- Configuration options
As well as a high-level overview of each skill in the rails-cto plugin.
Please review @/Users/matt/Workspace/active/rails-cto and let's starting building out pages that explain the project in a very smooth and digestable way.
Please interview me thoroughly for ideas and intent.
Requirements
- Node.js 20+ (VitePress requires 18+; 20 LTS is the floor this project targets)
- npm 10+
Install
npm installRun locally
Start the dev server with hot module reload:
npm run devThe site will be available at http://localhost:5173. Edits to any .md file, the VitePress config, or the custom theme hot-reload in the browser.
To run on a different port:
npm run dev -- --port 4024Build
Generate the static production site into .vitepress/dist/:
npm run buildPreview the production build
Serve the built output locally to sanity-check it before deploying:
npm run previewProject layout
.
├── .vitepress/
│ ├── config.mts # site metadata, nav, sidebar
│ └── theme/
│ ├── index.ts # extends the default theme
│ └── custom.css # brand colors and CSS var overrides
├── public/ # static assets served from /
├── index.md # home page (hero + features)
├── guide/ # guide section
├── services/ # services section
├── about.md
└── render.yaml # Render static site configDeploy
The site deploys to Render as a static site. The render.yaml at the repo root configures:
- Build command:
npm install && npm run build - Publish path:
./.vitepress/dist - Node version: 20
Pushing to the connected branch triggers a deploy automatically.