---
title: 项目设置概览
sidebarTitle: 设置概览
description: >-
  创建项目、连接 GitHub、整理仓库，并决定谁可以阅读文档。如果网站尚未上线，请从这里开始。
---

> **For AI agents:** the complete documentation index is at [llms.txt](/docs/llms.txt). Append `.md` to any page URL for its markdown version.

每个 Jamdesk 网站的起点都相同：仪表板中的一个项目、与之关联的 GitHub 仓库，以及描述导航结构的 `docs.json` 文件。本节介绍初始设置，以及适合尽早确定的结构决策。在拥有五十个页面之前确定 URL 结构、语言和访问控制，远比之后再处理容易。

要从其他平台迁移？请直接前往[迁移指南](/cn/setup/migration)。Jamdesk 可以自动完成大部分转换工作。

## 从仓库到上线网站

<Steps>
  <Step title="创建项目">
    从模板开始，或连接现有的 GitHub 仓库。网站会在 `yourproject.jamdesk.app` 上线。
  </Step>
  <Step title="连接 GitHub">
    安装 GitHub App，让每次推送都自动部署。
  </Step>
  <Step title="整理仓库">
    一个 `docs.json` 文件加上 MDX 页面。这就是全部约定。
  </Step>
</Steps>

## 核心设置

<Columns cols={3}>
  <Card title="创建项目" icon="rocket" href="/cn/setup/creating-projects">
    从模板或现有仓库创建并上线网站
  </Card>
  <Card title="连接 GitHub" icon="github" href="/cn/setup/connecting-github">
    应用安装、仓库访问权限，以及推送时自动部署
  </Card>
  <Card title="目录结构" icon="folder-tree" href="/cn/setup/directory-structure">
    必需文件、页面目录、图片和代码片段
  </Card>
  <Card title="迁移指南" icon="truck-moving" href="/cn/setup/migration">
    从其他文档平台迁移，可自动或手动完成
  </Card>
  <Card title="Monorepo 支持" icon="boxes-stacked" href="/cn/setup/monorepo-support">
    文档不在仓库根目录时，也能与代码放在一起
  </Card>
  <Card title="多语言支持" icon="language" href="/cn/setup/languages">
    通过语言切换器提供多种语言的文档
  </Card>
</Columns>

## 网站结构

<Columns cols={2}>
  <Card title="导航" icon="sitemap" href="/cn/navigation/overview">
    用于组织文档的标签页、分组和页面
  </Card>
  <Card title="重定向" icon="arrows-turn-right" href="/cn/setup/redirects">
    为已移动或重命名的页面设置精确或基于模式的重定向
  </Card>
</Columns>

## 隐私与访问权限

<Columns cols={3}>
  <Card title="访问控制" icon="shield-halved" href="/cn/setup/access-control">
    完全公开、密码保护、混合模式或 SSO。比较这些选项。
  </Card>
  <Card title="密码保护" icon="lock" href="/cn/setup/password-protection">
    使用共享密码锁定整个网站，或仅保护少数页面
  </Card>
  <Card title="单点登录 (SSO)" icon="key" href="/cn/setup/sso">
    通过身份提供商使用 SAML 或 OIDC
  </Card>
</Columns>