{"id":50800617,"url":"https://github.com/jamdesk/jamdesk-docs","last_synced_at":"2026-06-12T19:03:53.404Z","repository":{"id":331676303,"uuid":"1130579239","full_name":"jamdesk/jamdesk-docs","owner":"jamdesk","description":"Official Jamdesk documentation — guides, API reference, components, and tutorials for the Jamdesk documentation platform","archived":false,"fork":false,"pushed_at":"2026-06-08T21:34:52.000Z","size":5702,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-06-08T22:09:23.644Z","etag":null,"topics":["ai-agent","api-documentation","developer-documentation","developer-tools","docs-as-code","documentation","documentation-platform","documentation-tool","jamdesk","llms-txt","markdown","mcp","mdx","nextjs","openapi","rag","react","static-site-generator","technical-writing","typescript"],"latest_commit_sha":null,"homepage":"https://www.jamdesk.com/docs","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jamdesk.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-01-08T17:50:48.000Z","updated_at":"2026-06-08T21:34:56.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/jamdesk/jamdesk-docs","commit_stats":null,"previous_names":["jamdesk/jamdesk-docs"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/jamdesk/jamdesk-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamdesk%2Fjamdesk-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamdesk%2Fjamdesk-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamdesk%2Fjamdesk-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamdesk%2Fjamdesk-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jamdesk","download_url":"https://codeload.github.com/jamdesk/jamdesk-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamdesk%2Fjamdesk-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34258372,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-12T02:00:06.859Z","response_time":109,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai-agent","api-documentation","developer-documentation","developer-tools","docs-as-code","documentation","documentation-platform","documentation-tool","jamdesk","llms-txt","markdown","mcp","mdx","nextjs","openapi","rag","react","static-site-generator","technical-writing","typescript"],"created_at":"2026-06-12T19:03:47.728Z","updated_at":"2026-06-12T19:03:53.385Z","avatar_url":"https://github.com/jamdesk.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.jamdesk.com\"\u003e\n    \u003cpicture\u003e\n      \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"images/logo-dark.webp\"\u003e\n      \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"images/logo-light.webp\"\u003e\n      \u003cimg alt=\"Jamdesk\" src=\"images/logo-light.webp\" height=\"40\"\u003e\n    \u003c/picture\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.jamdesk.com/docs\"\u003e\u003cimg src=\"https://img.shields.io/badge/docs-jamdesk.com%2Fdocs-635BFF\" alt=\"Documentation\"\u003e\u003c/a\u003e\n  \u003ca href=\"https://www.npmjs.com/package/jamdesk\"\u003e\u003cimg src=\"https://img.shields.io/npm/v/jamdesk\" alt=\"npm version\"\u003e\u003c/a\u003e\n  \u003ca href=\"LICENSE\"\u003e\u003cimg src=\"https://img.shields.io/badge/license-Apache%202.0-blue\" alt=\"License: Apache 2.0\"\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n# Jamdesk Documentation\n\nSource files for the [Jamdesk documentation](https://www.jamdesk.com/docs) site. This repo contains the MDX content, not the Jamdesk platform source code. It also serves as a working example of a Jamdesk project: the same `docs.json` + `.mdx` files structure that any Jamdesk user would create.\n\n[Jamdesk](https://www.jamdesk.com) is a documentation platform that builds docs sites from MDX files in a GitHub repo. Push and your site deploys to a global CDN. It supports OpenAPI specs, AI chat (RAG + Claude), MCP server integration, automatic `llms.txt` generation, built-in analytics, and custom domains.\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://www.jamdesk.com/docs\"\u003e\n    \u003cimg src=\"images/themes/jam-theme.webp\" alt=\"Jamdesk docs site preview\" width=\"700\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## Repo Structure\n\n```\njamdesk-docs/\n├── docs.json              # Site config (navigation, theme, colors, redirects)\n├── introduction.mdx       # Homepage\n├── quickstart.mdx         # Getting started guide\n├── ai/                    # AI features (chat, MCP, llms.txt, Claude Code, Cursor)\n├── api-reference/         # OpenAPI example pages\n├── builds/                # Build system docs\n├── cli/                   # CLI documentation\n├── components/            # 22 MDX component reference pages\n├── content/               # Writing guides (MDX, code blocks, frontmatter, SEO)\n├── customization/         # Theming, branding, custom CSS/JS\n├── deploy/                # Deployment (custom domains, Vercel, Cloudflare, AWS)\n├── development/           # Local preview, VS Code extension\n├── help/                  # Help Center (account, billing, troubleshooting)\n├── integrations/          # GitHub, Google Analytics, Plausible, Slack\n├── images/                # Logos and screenshots\n├── openapi/               # OpenAPI spec files\n└── setup/                 # Project configuration and analytics\n```\n\n## Local Development\n\nThis repo is content only. To preview locally, install the [Jamdesk CLI](https://www.jamdesk.com/docs/cli/overview):\n\n```bash\nnpm install -g jamdesk\njamdesk dev\n```\n\nThe dev server starts at `http://localhost:3000` with hot reload.\n\n## Contributing\n\nContributions are welcome: typo fixes, clarifications, new examples, or missing docs.\n\n**Quick edits:** Click the pencil icon on any file in GitHub to edit directly. Changes auto-deploy when merged.\n\n**Larger changes:**\n\n1. Fork this repo\n2. Create a branch (`git checkout -b fix/typo-in-quickstart`)\n3. Edit the `.mdx` files (every page needs `title` and `description` frontmatter)\n4. Preview locally with `jamdesk dev` (optional)\n5. Submit a pull request\n\n**Found an issue?** [Open an issue](https://github.com/jamdesk/jamdesk-docs/issues) to report inaccuracies, request new content, or suggest improvements.\n\n### Writing Guidelines\n\n- Start with **why**, then show **how**; include working examples\n- Use MDX components: `\u003cSteps\u003e`, `\u003cTabs\u003e`, `\u003cCard\u003e`, `\u003cCallout\u003e`, `\u003cAccordion\u003e`, `\u003cCode\u003e`\n- Link related pages at the bottom with \"What's Next?\" cards\n- Page paths in `docs.json` navigation omit the `.mdx` extension\n\n### Adding a Page\n\n1. Create an `.mdx` file in the appropriate directory\n2. Add `title` and `description` frontmatter\n3. Add the page path to `docs.json` under the correct navigation group\n\n## Configuration\n\nAll site configuration lives in [`docs.json`](docs.json): navigation structure, theme, colors, API settings, redirects, and integrations. The schema is published at [`jamdesk.com/docs.json`](https://www.jamdesk.com/docs.json) and can be referenced with `\"$schema\": \"https://www.jamdesk.com/docs.json\"` for editor autocompletion. See the [docs.json reference](https://www.jamdesk.com/docs/reference/docs-json-reference) for full documentation.\n\n## Links\n\n- [Jamdesk website](https://www.jamdesk.com)\n- [Documentation](https://www.jamdesk.com/docs)\n- [Dashboard](https://dashboard.jamdesk.com)\n- [CLI on npm](https://www.npmjs.com/package/jamdesk)\n- [GitHub](https://github.com/jamdesk)\n- [@JamdeskHQ on X](https://x.com/JamdeskHQ)\n- [LinkedIn](https://www.linkedin.com/company/jamdesk)\n\n## License\n\nThis project is licensed under the [Apache License 2.0](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjamdesk%2Fjamdesk-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjamdesk%2Fjamdesk-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjamdesk%2Fjamdesk-docs/lists"}