diff --git a/AGENTS.md b/AGENTS.md index 256424d..ce60c54 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -4,7 +4,7 @@ Instructions for AI coding agents working on this codebase. ## Project overview -A real-time markdown blog powered by Convex and React. Content syncs instantly without rebuilds. Write markdown, run a sync command, and posts appear immediately across all connected browsers. +An open-source markdown sync site for developers and AI agents. Publish from the terminal with `npm run sync`. Write locally, sync instantly with real-time updates. Powered by Convex and Netlify. **Key features:** - Markdown posts with frontmatter diff --git a/README.md b/README.md index c0e1248..a087518 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # markdown "sync" site -An open-source markdown "sync" site you publish from the terminal with npm run sync. Write locally, sync instantly, skip the build powered by Convex and Netlify +An open-source markdown sync site for developers and AI agents. Publish from the terminal with `npm run sync`. Write locally, sync instantly with real-time updates. Powered by Convex and Netlify. Write markdown locally, run `npm run sync` (dev) or `npm run sync:prod` (production), and content appears instantly across all connected browsers. Built with React, Convex, and Vite. Optimized for SEO, AI agents, and LLM discovery. diff --git a/content/blog/about-this-blog.md b/content/blog/about-this-blog.md index f7a3c8b..d99e258 100644 --- a/content/blog/about-this-blog.md +++ b/content/blog/about-this-blog.md @@ -13,7 +13,7 @@ excerpt: "Learn how this open source site works with real-time sync and instant # About This Markdown Site -This is an open-source markdown sync site built with React, TypeScript, and Convex. Write posts and pages in markdown, sync them to a real-time database, and deploy on Netlify. +An open-source markdown sync site for developers and AI agents. Publish from the terminal with `npm run sync`. Write locally, sync instantly with real-time updates. Powered by Convex and Netlify. ## How It Works diff --git a/content/blog/setup-guide.md b/content/blog/setup-guide.md index e7ec6d5..806520c 100644 --- a/content/blog/setup-guide.md +++ b/content/blog/setup-guide.md @@ -8,7 +8,7 @@ tags: ["convex", "netlify", "tutorial", "deployment"] readTime: "8 min read" featured: true featuredOrder: 3 -image: "/public/images/setupguide.png" +image: "/images/setupguide.png" excerpt: "Complete guide to fork, set up, and deploy your own markdown blog in under 10 minutes." --- @@ -410,6 +410,22 @@ When you fork this project, update these files with your site information: | `public/openapi.yaml` | Server URL, site name in examples | | `public/.well-known/ai-plugin.json` | Site name, descriptions | +### Site title and description metadata + +These files contain the main site description text. Update them with your own tagline: + +| File | What to change | +| --------------------------------- | -------------------------------------------------------------- | +| `index.html` | meta description, og:description, twitter:description, JSON-LD | +| `README.md` | Main description at top of file | +| `src/pages/Home.tsx` | intro and bio text in siteConfig | +| `convex/http.ts` | description field in API responses (2 locations) | +| `convex/rss.ts` | SITE_DESCRIPTION constant | +| `public/llms.txt` | Header quote and Description field | +| `AGENTS.md` | Project overview section | +| `content/blog/about-this-blog.md` | Opening paragraph | +| `content/pages/about.md` | excerpt field and opening paragraph | + ### Update Backend Configuration These constants affect RSS feeds, API responses, sitemaps, and social sharing metadata. diff --git a/content/pages/about.md b/content/pages/about.md index a9eb8a3..085021c 100644 --- a/content/pages/about.md +++ b/content/pages/about.md @@ -3,10 +3,10 @@ title: "About" slug: "about" published: true order: 1 -excerpt: "A dev sync site builder for developers who want version-controlled content with real-time delivery." +excerpt: "An open-source markdown sync site for developers and AI agents." --- -This is a dev sync site builder for developers who want version-controlled content with real-time delivery. Write markdown locally, sync to a real-time database, and content appears instantly across all connected browsers. +An open-source markdown sync site for developers and AI agents. Publish from the terminal with `npm run sync`. Write locally, sync instantly with real-time updates. Powered by Convex and Netlify. ## What makes it a dev sync system diff --git a/content/pages/docs.md b/content/pages/docs.md index 8aa41d6..fe18260 100644 --- a/content/pages/docs.md +++ b/content/pages/docs.md @@ -164,6 +164,22 @@ When you fork this project, update these files with your site information: | `public/openapi.yaml` | Server URL, site name in examples | | `public/.well-known/ai-plugin.json` | Site name, descriptions | +### Site title and description metadata + +These files contain the main site description text. Update them with your own tagline: + +| File | What to change | +|------|----------------| +| `index.html` | meta description, og:description, twitter:description, JSON-LD | +| `README.md` | Main description at top of file | +| `src/pages/Home.tsx` | intro and bio text in siteConfig | +| `convex/http.ts` | description field in API responses (2 locations) | +| `convex/rss.ts` | SITE_DESCRIPTION constant | +| `public/llms.txt` | Header quote and Description field | +| `AGENTS.md` | Project overview section | +| `content/blog/about-this-blog.md` | Opening paragraph | +| `content/pages/about.md` | excerpt field and opening paragraph | + **Backend constants** (`convex/http.ts` and `convex/rss.ts`): ```typescript diff --git a/convex/http.ts b/convex/http.ts index f9c4b82..18fddc3 100644 --- a/convex/http.ts +++ b/convex/http.ts @@ -72,7 +72,7 @@ http.route({ const response = { site: SITE_NAME, url: SITE_URL, - description: "An open-source markdown sync site you publish from the terminal with npm run sync. Write locally, sync instantly, skip the build, powered by Convex and Netlify.", + description: "An open-source markdown sync site for developers and AI agents. Publish from the terminal with npm run sync. Write locally, sync instantly with real-time updates. Powered by Convex and Netlify.", posts: posts.map((post) => ({ title: post.title, slug: post.slug, @@ -194,7 +194,7 @@ http.route({ const response = { site: SITE_NAME, url: SITE_URL, - description: "An open-source markdown sync site you publish from the terminal with npm run sync. Write locally, sync instantly, skip the build, powered by Convex and Netlify.", + description: "An open-source markdown sync site for developers and AI agents. Publish from the terminal with npm run sync. Write locally, sync instantly with real-time updates. Powered by Convex and Netlify.", exportedAt: new Date().toISOString(), totalPosts: fullPosts.length, posts: fullPosts, diff --git a/convex/rss.ts b/convex/rss.ts index 9235439..91db304 100644 --- a/convex/rss.ts +++ b/convex/rss.ts @@ -5,7 +5,7 @@ import { api } from "./_generated/api"; const SITE_URL = process.env.SITE_URL || "https://markdowncms.netlify.app"; const SITE_TITLE = "markdown sync site"; const SITE_DESCRIPTION = - "An open-source markdown sync site you publish from the terminal with npm run sync. Write locally, sync instantly, skip the build, powered by Convex and Netlify."; + "An open-source markdown sync site for developers and AI agents. Publish from the terminal with npm run sync. Write locally, sync instantly with real-time updates. Powered by Convex and Netlify."; // Escape XML special characters function escapeXml(text: string): string { diff --git a/index.html b/index.html index c581c20..35e4815 100644 --- a/index.html +++ b/index.html @@ -8,7 +8,7 @@ @@ -41,7 +41,7 @@ An open-source markdown sync site you publish from the terminal with npm run sync. +> An open-source markdown sync site for developers and AI agents. Publish from the terminal with npm run sync. # Site Information - Name: markdown sync site - URL: https://markdowncms.netlify.app -- Description: An open-source markdown sync site you publish from the terminal with npm run sync. Write locally, sync instantly, skip the build, powered by Convex and Netlify. +- Description: An open-source markdown sync site for developers and AI agents. Publish from the terminal with npm run sync. Write locally, sync instantly with real-time updates. Powered by Convex and Netlify. - Topics: Markdown, Convex, React, TypeScript, Netlify, Open Source # API Endpoints diff --git a/public/raw/about-this-blog.md b/public/raw/about-this-blog.md index aa9e198..abfcad9 100644 --- a/public/raw/about-this-blog.md +++ b/public/raw/about-this-blog.md @@ -11,7 +11,7 @@ Tags: convex, netlify, open-source, markdown # About This Markdown Site -This is an open-source markdown sync site built with React, TypeScript, and Convex. Write posts and pages in markdown, sync them to a real-time database, and deploy on Netlify. +An open-source markdown sync site for developers and AI agents. Publish from the terminal with `npm run sync`. Write locally, sync instantly with real-time updates. Powered by Convex and Netlify. ## How It Works diff --git a/public/raw/about.md b/public/raw/about.md index ffd9226..3054d96 100644 --- a/public/raw/about.md +++ b/public/raw/about.md @@ -5,7 +5,7 @@ Type: page Date: 2025-12-20 --- -This is a dev sync site builder for developers who want version-controlled content with real-time delivery. Write markdown locally, sync to a real-time database, and content appears instantly across all connected browsers. +An open-source markdown sync site for developers and AI agents. Publish from the terminal with `npm run sync`. Write locally, sync instantly with real-time updates. Powered by Convex and Netlify. ## What makes it a dev sync system diff --git a/public/raw/docs.md b/public/raw/docs.md index 6e9dfe4..794688d 100644 --- a/public/raw/docs.md +++ b/public/raw/docs.md @@ -164,6 +164,22 @@ When you fork this project, update these files with your site information: | `public/openapi.yaml` | Server URL, site name in examples | | `public/.well-known/ai-plugin.json` | Site name, descriptions | +### Site title and description metadata + +These files contain the main site description text. Update them with your own tagline: + +| File | What to change | +|------|----------------| +| `index.html` | meta description, og:description, twitter:description, JSON-LD | +| `README.md` | Main description at top of file | +| `src/pages/Home.tsx` | intro and bio text in siteConfig | +| `convex/http.ts` | description field in API responses (2 locations) | +| `convex/rss.ts` | SITE_DESCRIPTION constant | +| `public/llms.txt` | Header quote and Description field | +| `AGENTS.md` | Project overview section | +| `content/blog/about-this-blog.md` | Opening paragraph | +| `content/pages/about.md` | excerpt field and opening paragraph | + **Backend constants** (`convex/http.ts` and `convex/rss.ts`): ```typescript diff --git a/public/raw/setup-guide.md b/public/raw/setup-guide.md index 355e450..05118f9 100644 --- a/public/raw/setup-guide.md +++ b/public/raw/setup-guide.md @@ -407,6 +407,22 @@ When you fork this project, update these files with your site information: | `public/openapi.yaml` | Server URL, site name in examples | | `public/.well-known/ai-plugin.json` | Site name, descriptions | +### Site title and description metadata + +These files contain the main site description text. Update them with your own tagline: + +| File | What to change | +| --------------------------------- | -------------------------------------------------------------- | +| `index.html` | meta description, og:description, twitter:description, JSON-LD | +| `README.md` | Main description at top of file | +| `src/pages/Home.tsx` | intro and bio text in siteConfig | +| `convex/http.ts` | description field in API responses (2 locations) | +| `convex/rss.ts` | SITE_DESCRIPTION constant | +| `public/llms.txt` | Header quote and Description field | +| `AGENTS.md` | Project overview section | +| `content/blog/about-this-blog.md` | Opening paragraph | +| `content/pages/about.md` | excerpt field and opening paragraph | + ### Update Backend Configuration These constants affect RSS feeds, API responses, sitemaps, and social sharing metadata. diff --git a/src/pages/Home.tsx b/src/pages/Home.tsx index 5ae32d3..5b0cdef 100644 --- a/src/pages/Home.tsx +++ b/src/pages/Home.tsx @@ -18,8 +18,8 @@ const siteConfig = { logo: "/images/logo.svg" as string | null, intro: ( <> - An open-source markdown "sync" site you publish from the terminal with npm - run sync.{" "} + An open-source markdown sync site for developers and AI agents. Publish + from the terminal with npm run sync.{" "} ), - bio: `Write locally, sync instantly, skip the build. Powered by Convex and Netlify.`, + bio: `Write locally, sync instantly with real-time updates. Powered by Convex and Netlify.`, // Featured section configuration // viewMode: 'list' shows bullet list, 'cards' shows card grid with excerpts