mirror of
https://github.com/waynesutton/markdown-site.git
synced 2026-01-11 20:08:57 +00:00
update: updated sync commands documentation
This commit is contained in:
14
README.md
14
README.md
@@ -14,6 +14,8 @@ Write markdown locally, run `npm run sync` (dev) or `npm run sync:prod` (product
|
||||
|
||||
**Sync commands:**
|
||||
|
||||
Sync command scripts are located in `scripts/` (sync-posts.ts, sync-discovery-files.ts).
|
||||
|
||||
**Development:**
|
||||
|
||||
- `npm run sync` - Sync markdown content
|
||||
@@ -26,6 +28,11 @@ Write markdown locally, run `npm run sync` (dev) or `npm run sync:prod` (product
|
||||
- `npm run sync:discovery:prod` - Update discovery files
|
||||
- `npm run sync:all:prod` - Sync content + discovery files together
|
||||
|
||||
**Export dashboard content:**
|
||||
|
||||
- `npm run export:db` - Export dashboard posts/pages to content folders (development)
|
||||
- `npm run export:db:prod` - Export dashboard posts/pages (production)
|
||||
|
||||
**How versioning works:** Markdown files live in `content/blog/` and `content/pages/`. These are regular files in your git repo. Commit changes, review diffs, roll back like any codebase. The sync command pushes content to Convex.
|
||||
|
||||
```bash
|
||||
@@ -319,6 +326,8 @@ Both files are gitignored. Each developer creates their own.
|
||||
|
||||
### Sync Commands
|
||||
|
||||
Sync command scripts are located in `scripts/` (sync-posts.ts, sync-discovery-files.ts).
|
||||
|
||||
**Development:**
|
||||
|
||||
- `npm run sync` - Sync markdown content to development Convex
|
||||
@@ -331,6 +340,11 @@ Both files are gitignored. Each developer creates their own.
|
||||
- `npm run sync:discovery:prod` - Update discovery files with production data
|
||||
- `npm run sync:all:prod` - Sync content + discovery files together
|
||||
|
||||
**Export dashboard content:**
|
||||
|
||||
- `npm run export:db` - Export dashboard posts/pages to content folders (development)
|
||||
- `npm run export:db:prod` - Export dashboard posts/pages (production)
|
||||
|
||||
**Development sync:**
|
||||
|
||||
```bash
|
||||
|
||||
@@ -18,6 +18,8 @@ An open-source publishing framework built for AI agents and developers to ship w
|
||||
|
||||
**Sync commands:**
|
||||
|
||||
Sync command scripts are located in `scripts/` (sync-posts.ts, sync-discovery-files.ts).
|
||||
|
||||
**Development:**
|
||||
|
||||
- <span class="copy-command">npm run sync</span> - Sync markdown content
|
||||
|
||||
@@ -348,30 +348,32 @@ This creates a file in `content/blog/` that requires syncing.
|
||||
|
||||
### Sync commands reference
|
||||
|
||||
Sync command scripts are located in `scripts/` (sync-posts.ts, sync-discovery-files.ts).
|
||||
|
||||
**Development:**
|
||||
|
||||
- `npm run sync` - Sync markdown content to development Convex
|
||||
- `npm run sync:discovery` - Update discovery files (AGENTS.md, llms.txt) with development data
|
||||
- `npm run sync:all` - Run both content sync and discovery sync (development)
|
||||
- <span class="copy-command">npm run sync</span> - Sync markdown content to development Convex
|
||||
- <span class="copy-command">npm run sync:discovery</span> - Update discovery files (AGENTS.md, llms.txt) with development data
|
||||
- <span class="copy-command">npm run sync:all</span> - Run both content sync and discovery sync (development)
|
||||
|
||||
**Production:**
|
||||
|
||||
- `npm run sync:prod` - Sync markdown content to production Convex
|
||||
- `npm run sync:discovery:prod` - Update discovery files with production data
|
||||
- `npm run sync:all:prod` - Run both content sync and discovery sync (production)
|
||||
- <span class="copy-command">npm run sync:prod</span> - Sync markdown content to production Convex
|
||||
- <span class="copy-command">npm run sync:discovery:prod</span> - Update discovery files with production data
|
||||
- <span class="copy-command">npm run sync:all:prod</span> - Run both content sync and discovery sync (production)
|
||||
|
||||
**Sync Server:**
|
||||
|
||||
- `npm run sync-server` - Start local HTTP server for executing sync commands from dashboard UI
|
||||
- <span class="copy-command">npm run sync-server</span> - Start local HTTP server for executing sync commands from dashboard UI
|
||||
|
||||
**Content Import:**
|
||||
|
||||
- `npm run import <url>` - Import external URL as markdown post (requires FIRECRAWL_API_KEY in .env.local)
|
||||
- <span class="copy-command">npm run import <url></span> - Import external URL as markdown post (requires FIRECRAWL_API_KEY in .env.local)
|
||||
|
||||
**Database Export:**
|
||||
|
||||
- `npm run export:db` - Export dashboard posts/pages to content folders (development)
|
||||
- `npm run export:db:prod` - Export dashboard posts/pages (production)
|
||||
- <span class="copy-command">npm run export:db</span> - Export dashboard posts/pages to content folders (development)
|
||||
- <span class="copy-command">npm run export:db:prod</span> - Export dashboard posts/pages (production)
|
||||
|
||||
**Note:** The dashboard provides a UI for these commands. When the sync server is running (`npm run sync-server`), you can execute commands directly from the dashboard with real-time output. Otherwise, the dashboard shows commands in a modal for copying to your terminal.
|
||||
|
||||
|
||||
@@ -23,6 +23,8 @@ Reference documentation for setting up, customizing, and deploying this markdown
|
||||
|
||||
**Sync commands:**
|
||||
|
||||
Sync command scripts are located in `scripts/` (sync-posts.ts, sync-discovery-files.ts).
|
||||
|
||||
**Development:**
|
||||
|
||||
- <span class="copy-command">npm run sync</span> - Sync markdown content
|
||||
|
||||
@@ -17,6 +17,8 @@ An open-source publishing framework built for AI agents and developers to ship w
|
||||
|
||||
**Sync commands:**
|
||||
|
||||
Sync command scripts are located in `scripts/` (sync-posts.ts, sync-discovery-files.ts).
|
||||
|
||||
**Development:**
|
||||
|
||||
- <span class="copy-command">npm run sync</span> - Sync markdown content
|
||||
|
||||
@@ -340,30 +340,32 @@ This creates a file in `content/blog/` that requires syncing.
|
||||
|
||||
### Sync commands reference
|
||||
|
||||
Sync command scripts are located in `scripts/` (sync-posts.ts, sync-discovery-files.ts).
|
||||
|
||||
**Development:**
|
||||
|
||||
- `npm run sync` - Sync markdown content to development Convex
|
||||
- `npm run sync:discovery` - Update discovery files (AGENTS.md, llms.txt) with development data
|
||||
- `npm run sync:all` - Run both content sync and discovery sync (development)
|
||||
- <span class="copy-command">npm run sync</span> - Sync markdown content to development Convex
|
||||
- <span class="copy-command">npm run sync:discovery</span> - Update discovery files (AGENTS.md, llms.txt) with development data
|
||||
- <span class="copy-command">npm run sync:all</span> - Run both content sync and discovery sync (development)
|
||||
|
||||
**Production:**
|
||||
|
||||
- `npm run sync:prod` - Sync markdown content to production Convex
|
||||
- `npm run sync:discovery:prod` - Update discovery files with production data
|
||||
- `npm run sync:all:prod` - Run both content sync and discovery sync (production)
|
||||
- <span class="copy-command">npm run sync:prod</span> - Sync markdown content to production Convex
|
||||
- <span class="copy-command">npm run sync:discovery:prod</span> - Update discovery files with production data
|
||||
- <span class="copy-command">npm run sync:all:prod</span> - Run both content sync and discovery sync (production)
|
||||
|
||||
**Sync Server:**
|
||||
|
||||
- `npm run sync-server` - Start local HTTP server for executing sync commands from dashboard UI
|
||||
- <span class="copy-command">npm run sync-server</span> - Start local HTTP server for executing sync commands from dashboard UI
|
||||
|
||||
**Content Import:**
|
||||
|
||||
- `npm run import <url>` - Import external URL as markdown post (requires FIRECRAWL_API_KEY in .env.local)
|
||||
- <span class="copy-command">npm run import <url></span> - Import external URL as markdown post (requires FIRECRAWL_API_KEY in .env.local)
|
||||
|
||||
**Database Export:**
|
||||
|
||||
- `npm run export:db` - Export dashboard posts/pages to content folders (development)
|
||||
- `npm run export:db:prod` - Export dashboard posts/pages (production)
|
||||
- <span class="copy-command">npm run export:db</span> - Export dashboard posts/pages to content folders (development)
|
||||
- <span class="copy-command">npm run export:db:prod</span> - Export dashboard posts/pages (production)
|
||||
|
||||
**Note:** The dashboard provides a UI for these commands. When the sync server is running (`npm run sync-server`), you can execute commands directly from the dashboard with real-time output. Otherwise, the dashboard shows commands in a modal for copying to your terminal.
|
||||
|
||||
|
||||
@@ -13,6 +13,8 @@ Reference documentation for setting up, customizing, and deploying this markdown
|
||||
|
||||
**Sync commands:**
|
||||
|
||||
Sync command scripts are located in `scripts/` (sync-posts.ts, sync-discovery-files.ts).
|
||||
|
||||
**Development:**
|
||||
|
||||
- <span class="copy-command">npm run sync</span> - Sync markdown content
|
||||
|
||||
Reference in New Issue
Block a user