GitRead Docs

Getting started

Quickstart

This guide takes you from a new account to a published page.

1. Create an account

Register with your email address and confirm it. After signing in you land in the editor panel.

2. Create a project

  1. In the left column, click the + button next to Projects.
  2. Enter a name and confirm.

Your project opens with an empty page tree. You can rename the project at any time.

3. Write your first page

  1. Click New page at the bottom of the page list.
  2. Give the page a title at the top of the editor.
  3. Press Enter or click into the body and start writing. Type / to open the block menu.

There is no save button. The editor saves automatically a moment after you stop typing. The status next to the Edit and Preview switch shows whether your changes are saved.

Use the Preview tab to see the page as readers will see it.

4. Organize your pages

  • Click New group to add a heading to the navigation.
  • Drag pages into a group, or onto another page to make them a subpage.

See Pages and groups for all options.

5. Publish

New projects are private. To share them:

  1. Open the project Settings with the gear icon next to the project name.
  2. Under Visibility, choose Via link or Password protected.
  3. Click Save and copy the Public link.

Anyone you send the link to can now read your docs. See Visibility and sharing for details.

What's next

  • Make your docs look like your brand: Branding.
  • Use your own domain: Custom domain.
  • Let readers ask questions: Ask AI.
  • Let an AI assistant help you write: Connect an AI assistant.