GitRead Docs

Getting started

Core concepts

Projects

A project is one documentation site, for example the docs of a product. Everything that belongs to the site is configured per project:

  • name, display name and description
  • visibility and password
  • default page elements
  • footer, logo and favicon
  • custom domain
  • the company name used by Ask AI

You can switch between projects in the left column of the editor. Deleting a project permanently removes all its pages and groups, and its public link stops working.

Pages

Pages hold your content. Each page has a title and a body made of blocks. Under the hood the body is stored as Markdown, so your content is never locked in. Readers can even open any public page as raw Markdown by adding .md to its address.

Pages can be nested: a page can have subpages, and subpages can have subpages of their own, up to ten levels deep.

Groups

Groups are headings in the navigation. Use them to split a long page list into topics such as Getting started or API reference. Deleting a group never deletes its pages.

Every project gets a public link that does not change when you rename the project or its pages. Each page has its own address below it. If you add a custom domain, the same pages are served from your domain.

What readers see

The public site shows your pages with:

  • a navigation tree on the left
  • a table of contents on the right
  • search, opened with Ctrl + K (Cmd + K on Mac)
  • light and dark mode
  • Previous and Next cards at the end of each page
  • a Copy page menu that copies the page as Markdown
  • an optional Ask AI button

You decide which of these elements are shown. See Page elements.

Plans

Your plan sets how many projects and pages you can create and which features you can use, such as custom domains, removing the Powered by GitRead note and AI assistant access. See Plans and limits.