GitRead Docs

Introduction

GitRead is a place to write, organize and publish documentation. You write in a block editor in your browser, arrange your pages in a tree, and share the result as a clean, searchable documentation site with a single link.

What you get

  • A block editor that feels like writing a document. Type / to insert headings, lists, tables, code, hints, diagrams and more. Your work is saved automatically.
  • Projects that hold your pages and groups. Each project has its own public address, branding and settings.
  • Flexible sharing. Keep a project private, share it with anyone who has the link, or protect it with a password.
  • Your own look. Add a footer with your logo and links, a favicon, and serve your docs from your own domain.
  • Ask AI for your readers. Visitors can ask questions in plain language and get answers based on your pages.
  • AI assistant access for you. Connect an AI assistant such as Claude to your projects so it can read, search and write pages for you.

How GitRead is organized

Your account
└── Project
    ├── Group
    │   ├── Page
    │   │   └── Subpage
    │   └── Page
    └── Page
Concept What it is
Project One documentation site. It has a name, visibility, branding and its own public link.
Group A heading in the navigation that bundles related pages.
Page A single document written in the editor. Pages can have subpages.

Read Core concepts for a closer look.

Where to go next

  • Quickstart: publish your first page in a few minutes.
  • Editor overview: everything the editor can do.
  • Visibility and sharing: control who can read your docs.
  • Ask AI: let readers ask questions about your docs.

/