Jamdesk Documentation logo

Project Setup Overview

Create a project, connect GitHub, organize your repo, and decide who can read your docs. Start here if your site isn't live yet.

A Jamdesk site is a project in the dashboard, a GitHub repo behind it, and a docs.json file that describes your navigation. This section covers that setup. Settle URL layout, languages, and access control early. They are harder to change once you have fifty pages.

To move from another platform, see the Migration Guide.

From Repo to Live Site

1
Create a project

Start from a template or connect an existing GitHub repo. Your site goes live at yourproject.jamdesk.app.

2
Connect GitHub

Install the GitHub App so every push deploys automatically.

3
Organize the repo

Add a docs.json file and MDX pages.

Core Setup

Create a Project

From a template or an existing repo to a live site

Connect GitHub

App installation, repository access, and automatic deploys on push

Directory Structure

Required files, page directories, images, and snippets

Migration Guide

Move from another documentation platform, automated or manual

Monorepo Support

Keep docs alongside your code when they aren't at the repo root

Multi-Language Support

Serve docs in multiple languages with a language switcher

Site Structure

Navigation

Tabs, groups, and pages that organize your documentation

Redirects

Exact and pattern-based redirects for moved or renamed pages

Privacy & Access

Access Control

Fully public, password-gated, mixed, or SSO. Compare the options.

Password Protection

Lock the whole site or a few pages behind a shared password

Single Sign-On (SSO)

SAML or OIDC through your identity provider