Frequently Asked Questions

Jamdesk is a documentation platform that builds docs sites from your Markdown files. Write in MDX and push to GitHub. Your site deploys with search, analytics, and an llms.txt file for AI tools.

No. MDX is plain text with simple formatting. Components are optional.

Yes. We offer a 14-day free trial with every feature.

Your docs are plain MDX files in a GitHub repo, not locked in a proprietary editor. Push to GitHub and your site deploys in under 60 seconds. There is no build configuration or CI/CD pipeline to set up. Every site gets llms.txt and an MCP server. AI tools like Claude and ChatGPT can read your current docs directly. Visitors get a built-in AI chat assistant that answers questions from your docs.

Most documentation sites build in 30-60 seconds. Larger sites with many pages may take longer.

Yes. Preview locally with hot reload using the Jamdesk CLI (jamdesk dev). Changes go live only when you push to GitHub or run jamdesk deploy.

Yes. Run jamdesk deploy from your project directory. The CLI packages and uploads your files, then triggers a build. No Git repo required. See the CLI Deploy guide for details.

A push to your connected GitHub branch. You can also trigger a build from the dashboard, or with jamdesk deploy from the CLI.

Yes. Go to Deployments in your project. Find the previous build and click Rollback.

The Pro plan is $29/month and includes one docs project. Each additional project is $15/month. See Plans & Pricing for details.

No. We offer a 14-day free trial. After that, you need a Pro subscription.

We accept Visa, Mastercard, American Express, and Discover credit cards.

We offer refunds within 30 days of your first payment. Contact support to request one.

Yes. Add a custom domain in Settings → Domains. Jamdesk provisions the SSL certificate.

Usually a few hours. It can take up to 48 hours.

Yes. Use a reverse proxy (Cloudflare, AWS, nginx) to serve Jamdesk at a subpath. See Subpath Hosting.

Open your project and go to Settings → Members. Type the person's email in the Invite Member field and click Invite. They get an email with a link to join the project.

Invitees need a Jamdesk account. The invite prompts them to create one if they don't have it. Already a member, but the invite link says it's "already been accepted"? Sign in. You'll land back in the project. See Team Members for roles and member limits.

Unlimited, on every plan, at no extra charge.

Team members can view builds and trigger rebuilds. Editing happens in your GitHub repository. Anyone with repository access can edit the docs.

Go to Settings → Members. Click Transfer Ownership next to the member you want to promote. The new owner must be an existing team member.

In ~/.jamdeskrc, a JSON file with 0600 permissions (only your user can read it). It stores your refresh token, email, and user ID. Run jamdesk logout to clear it.

Your refresh token is no longer valid. This happens after password changes, account deletions, or extended inactivity. Run jamdesk login to get a fresh session.

Yes. The browser-based login won't work in headless environments. Log in on your local machine. Copy ~/.jamdeskrc to your CI runner. The refresh token authenticates from there.

Run jamdesk fix. It repairs broken internal links that have one clear correct target (typo'd anchors and cross-locale anchor drift). It edits your local .mdx files after a preview. See the planned changes first with jamdesk fix --dry-run. It touches only links whose corrected anchor is a real heading. Ambiguous cases stay for manual review. See Auto-fix broken links.

MDX (Markdown + JSX) and standard Markdown files.

Yes. Define inline components in MDX with export const, or create reusable components in the /snippets directory. For interactive components with hooks, use .tsx files with 'use client'. See Custom React Components and Snippets.

No hard limit. Sites with hundreds of pages build and run fine.

Yes. Add a language switcher with the languages property in your navigation config. Each language gets its own navigation structure and content. See Multi-Language Support.

No. You provide the translated MDX files. Jamdesk builds the routing, navigation, language switcher, and RTL styling. Bring translations from your own workflow (human translators, machine translation, or an LLM). Place them in language-prefixed directories (es/, fr/, etc.). See Multi-Language Support for the directory layout and config.

Yes. Every Jamdesk site includes a built-in chat assistant that answers visitor questions from your documentation. It's on by default. See AI Chat for details.

No. AI chat is included on every plan.

Yes. Set chat.enabled to false in your docs.json:

{ "chat": { "enabled": false } }

Your next build removes the chat panel and keyboard shortcut.

Only your published documentation pages. Each build indexes your content into a vector database. Jamdesk retrieves the sections relevant to a visitor's question and sends them to Claude as context. The AI cannot access data outside your docs.

Yes. Mark internal pages with private: true in frontmatter, or list their paths under auth.password.private[] in docs.json. Private pages show an unlock screen. Every page stays in one project, with one repo and one build. See Access Control and Password Protection.

Set auth.password.enabled: true in docs.json and push the change. Set a password in Project Settings → Password Protection in the dashboard. Visitors see an unlock screen until they enter it. See Password Protection.

Yes, on Enterprise plans. Single Sign-On lets readers authenticate against your identity provider (Okta, Google Workspace, Azure AD, etc.) with no shared passwords, a full audit trail, and instant deprovisioning. See SSO or contact Enterprise sales.

Usually no. Use one project with private: true on the internal pages. You keep one repo and one dashboard. Use two projects only when the audiences need separate branding, custom domains, or analytics. See Access Control for the patterns.

Editors write the docs by committing MDX to your connected GitHub repo. A push builds only if the person who pushed is a member of the Jamdesk project or an automation account you've authorized. Readers view the published site: everyone (public), anyone with the password (password mode), or anyone signed in via your IdP (SSO). Dashboard team members control builds, analytics, and settings. Membership also lets their pushes build. See Access Control.