x/wiki
1
0
Fork 0
mirror of https://github.com/waynesutton/markdown-site.git synced 2026-01-12 04:09:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update site description across 9 files and add metadata table to setup guide

Browse Source
This commit is contained in:
Wayne Sutton
2025-12-20 11:33:14 -08:00
parent 997b9cad21
commit 4ae8579f48
15 changed files with 84 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
AGENTS.md
View File

@@ -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

2
README.md
View File

@@ -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.

2
content/blog/about-this-blog.md
View File

@@ -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

18
content/blog/setup-guide.md
View File

@@ -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.

4
content/pages/about.md
View File

@@ -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

16
content/pages/docs.md
View File

@@ -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

4
convex/http.ts
View File

@@ -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,

2
convex/rss.ts
View File

@@ -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 {

8
index.html
View File

@@ -8,7 +8,7 @@
<!-- SEO Meta Tags -->
<meta
name="description"
content="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."
content="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."
/>
<meta name="author" content="markdown sync site" />
<meta
@@ -24,7 +24,7 @@
<meta property="og:title" content="markdown sync site" />
<meta
property="og:description"
content="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."
content="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."
/>
<meta property="og:type" content="website" />
<meta property="og:url" content="https://markdowncms.netlify.app/" />
@@ -41,7 +41,7 @@
<meta name="twitter:title" content="markdown sync site" />
<meta
name="twitter:description"
content="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."
content="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."
/>
<meta
name="twitter:image"
@@ -72,7 +72,7 @@
"@type": "WebSite",
"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.",
"author": {
"@type": "Organization",
"name": "markdown sync site",

4
public/llms.txt
View File

@@ -1,12 +1,12 @@
# llms.txt - Information for AI assistants and LLMs
# Learn more: https://llmstxt.org/
> 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

2
public/raw/about-this-blog.md
View File

@@ -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

2
public/raw/about.md
View File

@@ -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

16
public/raw/docs.md
View File

@@ -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

16
public/raw/setup-guide.md
View File

@@ -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.

6
src/pages/Home.tsx
View File

@@ -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.{" "}
<a
href="https://github.com/waynesutton/markdown-site"
target="_blank"
@@ -31,7 +31,7 @@ const siteConfig = {
, customize it, ship it.
</>
),
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