<a href="https://www.speakeasy.com/product/gram" target="_blank">
<picture>
<source media="(prefers-color-scheme: light)" srcset="https://github.com/user-attachments/assets/1812f171-1650-4045-ac35-21bdd7b103a6">
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/user-attachments/assets/3f14e446-0dec-4b8a-b36e-fd92efc25751">
<img src="https://github.com/user-attachments/assets/3f14e446-0dec-4b8a-b36e-fd92efc25751#gh-dark-mode-only" alt="Gram">
</picture>
</a>

This is an Archive

This repository has been migrated into the main Gram
repository. Please submit
any future changes or pull requests there.

Gram Docs

This repository contains the documentation for the Gram app.

To run

cp .env-example .env
npm i
npm run dev

Now you can visit the project locally at http://localhost:4321.

🚀 Project Structure

Inside this Astro + Starlight project, you'll see the following folders and files:

.
├── public/                # Static assets that will _not_ be processed by Astro
├── src/
│   ├── assets/            # Images that will be optimized by Astro
│   ├── components/        # Shared components that override Starlight's default components
│   ├── content/           # All the content for the site
│   ├── fonts/             # Fonts used throughout the site
│   ├── pages/             # Additional pages or special paths to be added to the site
│   ├── styles/global.css  # Tailwind theme configuration and startlight style overrides
│   ├── content.config.ts  # Configuration for content collections
│   └── route-data.ts      # Middleware for injecting metadata into site routes
├── astro.config.mjs       # Astro configuration
├── package.json           # Dependencies
└── tsconfig.json          # TypeScript configuration

Starlight looks for .md or .mdx files in the src/content/docs/ directory. Each file is exposed as a route based on its file name.

Images can be added to src/assets/ and embedded in Markdown with a relative link.

Static assets, like favicons, can be placed in the public/ directory.

🧞 Commands

All commands are run from the root of the project, from a terminal:

👀 Built with Starlight

Check out Starlight’s docs, read the Astro documentation, or jump into the Astro Discord server.