{"id":50800680,"url":"https://github.com/jamdesk/starter-docs","last_synced_at":"2026-06-12T19:04:10.977Z","repository":{"id":335542970,"uuid":"1144646386","full_name":"jamdesk/starter-docs","owner":"jamdesk","description":"Starter documentation template for Jamdesk — get started in seconds with MDX docs","archived":false,"fork":false,"pushed_at":"2026-04-28T03:06:58.000Z","size":52,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-04-28T05:07:57.213Z","etag":null,"topics":["docs-as-code","documentation","jamdesk","mdx","starter-template","template"],"latest_commit_sha":null,"homepage":"https://www.jamdesk.com","language":"MDX","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","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-28T22:17:38.000Z","updated_at":"2026-04-28T03:07:01.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/jamdesk/starter-docs","commit_stats":null,"previous_names":["jamdesk/starter-docs"],"tags_count":0,"template":true,"template_full_name":null,"purl":"pkg:github/jamdesk/starter-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamdesk%2Fstarter-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamdesk%2Fstarter-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamdesk%2Fstarter-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamdesk%2Fstarter-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jamdesk","download_url":"https://codeload.github.com/jamdesk/starter-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamdesk%2Fstarter-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34258374,"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":["docs-as-code","documentation","jamdesk","mdx","starter-template","template"],"created_at":"2026-06-12T19:04:10.040Z","updated_at":"2026-06-12T19:04:10.961Z","avatar_url":"https://github.com/jamdesk.png","language":"MDX","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Jamdesk Starter Template\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE)\n\nThe official starter template for [Jamdesk](https://jamdesk.com) documentation sites. Clone this repository to create beautiful, professional documentation in minutes.\n\n**[Documentation](https://jamdesk.com/docs)** · **[Get Started](https://jamdesk.com/docs/quickstart)** · **[Dashboard](https://dashboard.jamdesk.com)**\n\n## What is Jamdesk?\n\n[Jamdesk](https://jamdesk.com) is a modern documentation platform that transforms MDX (Markdown + React components) into polished, production-ready documentation websites.\n\n**Why teams choose Jamdesk:**\n- **Write in MDX** - Markdown with React components for interactive docs\n- **Deploy instantly** - Push to GitHub, deploy globally in seconds\n- **Professional themes** - Three built-in themes (Jam, Nebula, Pulsar)\n- **AI-ready** - Auto-generates `llms.txt` for ChatGPT, Claude, Copilot\n- **Built-in search** - AI-powered search out of the box\n- **Analytics included** - Track page views and search queries\n\n## What's Included\n\nThis starter template includes everything you need to get started:\n\n```\nstarter-docs/\n├── docs.json              # Site configuration (theme, colors, navigation)\n├── introduction.mdx       # Welcome page\n├── quickstart.mdx         # Getting started guide\n├── api-reference/         # API documentation example pages\n│   ├── openapi-example.mdx          # Live-rendered OpenAPI endpoint\n│   └── request-response-examples.mdx # Hand-authored request/response demo\n├── components/            # Component examples\n│   ├── callouts.mdx       # Notes, warnings, tips\n│   ├── cards.mdx          # Card layouts\n│   ├── steps.mdx          # Step-by-step guides\n│   └── tabs-and-accordions.mdx\n├── openapi/               # OpenAPI specification files\n│   └── example-api.yaml   # Sample Acme Support API spec\n└── writing/               # Content writing guides\n    ├── code-blocks.mdx    # Syntax highlighting\n    ├── components.mdx     # Using MDX components\n    └── pages.mdx          # Page structure\n```\n\n**Theme:** This template uses the **Jam** theme - a clean, modern design with purple accent colors. [See all themes →](https://jamdesk.com/docs/customization/theming)\n\n## Quick Start\n\n### Option 1: Use the Dashboard (Recommended)\n\n1. Sign up at [dashboard.jamdesk.com](https://dashboard.jamdesk.com)\n2. Create a new project and select \"Starter Template\"\n3. Connect your GitHub repository\n4. Start editing - changes deploy automatically\n\n### Option 2: Use This Template\n\nClick the green **\"Use this template\"** button at the top of this page to create your own repository based on this starter.\n\n### Option 3: Clone and Deploy\n\n```bash\n# Clone this template\ngit clone https://github.com/jamdesk/starter-docs.git my-docs\ncd my-docs\n\n# Preview locally (requires Jamdesk CLI)\nnpm install -g jamdesk\njamdesk dev\n\n# Open http://localhost:3000\n```\n\nThen connect your repository to Jamdesk via the [dashboard](https://dashboard.jamdesk.com).\n\n## Customization\n\n### Change Theme Colors\n\nEdit `docs.json` to customize your brand colors:\n\n```json\n{\n  \"colors\": {\n    \"primary\": \"#6366F1\",\n    \"light\": \"#818CF8\",\n    \"dark\": \"#4F46E5\"\n  }\n}\n```\n\n### Switch Themes\n\nChange the theme in `docs.json`:\n\n```json\n{\n  \"theme\": \"jam\"      // Options: \"jam\", \"nebula\", \"pulsar\"\n}\n```\n\n### Add Your Logo\n\n```json\n{\n  \"logo\": {\n    \"light\": \"/images/logo-light.svg\",\n    \"dark\": \"/images/logo-dark.svg\"\n  }\n}\n```\n\n## Writing Content\n\nAll content is written in MDX - Markdown with React components:\n\n```mdx\n---\ntitle: My Page\ndescription: A brief description for SEO\n---\n\n# Welcome\n\nThis is regular Markdown with **bold** and *italic* text.\n\n\u003cNote\u003e\n  This is a callout component for important information.\n\u003c/Note\u003e\n\n\u003cSteps\u003e\n  \u003cStep title=\"First\"\u003eDo this first\u003c/Step\u003e\n  \u003cStep title=\"Second\"\u003eThen do this\u003c/Step\u003e\n\u003c/Steps\u003e\n```\n\n**Available components:** Cards, Tabs, Accordions, Steps, Callouts, Code Groups, and [25+ more →](https://jamdesk.com/docs/components/overview)\n\n## Local Development\n\nPreview your docs locally with hot reload:\n\n```bash\n# Install the CLI (choose one)\nnpm install -g jamdesk          # via npm\nbrew install jamdesk/tap/jamdesk # via Homebrew\n\n# Start the dev server\njamdesk dev\n\n# Validate your docs\njamdesk validate\n\n# Check for broken links\njamdesk broken-links\n```\n\n## Documentation\n\n- [Jamdesk Documentation](https://jamdesk.com/docs) - Full platform docs\n- [Quickstart Guide](https://jamdesk.com/docs/quickstart) - Get started in 5 minutes\n- [MDX Basics](https://jamdesk.com/docs/content/mdx-basics) - Writing content\n- [Components](https://jamdesk.com/docs/components/overview) - All available components\n- [Theming](https://jamdesk.com/docs/customization/theming) - Customize your site\n- [docs.json Reference](https://jamdesk.com/docs/config/docs-json-reference) - Full configuration options\n\n## Deploy\n\nJamdesk handles deployment automatically:\n\n1. Push changes to your connected GitHub repository\n2. Jamdesk builds your site (typically under 30 seconds)\n3. Your docs are live on your custom domain or `yoursite.jamdesk.app`\n\nNo build configuration required. No CI/CD setup needed.\n\n## Support\n\n- **Documentation:** [jamdesk.com/docs](https://jamdesk.com/docs)\n- **Help Center:** [jamdesk.com/docs/help](https://jamdesk.com/docs/help/faq)\n- **Issues:** [github.com/jamdesk/starter-docs/issues](https://github.com/jamdesk/starter-docs/issues)\n\n## License\n\nMIT - Use this template for any project, commercial or personal.\n\n---\n\nBuilt with [Jamdesk](https://jamdesk.com) - Beautiful documentation that developers actually love.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjamdesk%2Fstarter-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjamdesk%2Fstarter-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjamdesk%2Fstarter-docs/lists"}