GitRead Docs

Features

Visibility and sharing

Each project has its own visibility. Open it in Project settings under Visibility.

Visibility options

Option Who can read
Private Only you, while you are signed in. This is the default for new projects.
Via link Anyone who has the link. The docs are not listed anywhere, so only people you share the link with find them.
Password protected Visitors must enter the password before they can read anything.

Via link is not a login. Anyone who receives the link can forward it. If your content is sensitive, use a password.

Share your docs

  1. Open the project settings with the gear icon next to the project name.
  2. Choose a visibility and, for password protection, enter a password with at least four characters.
  3. Click Save.
  4. Copy the Public link or click Open to check how it looks to visitors.

Change the password

Open the settings, enter a new password and save. Visitors who had unlocked the docs with the old password are asked for the new one the next time they open a page. Leave the field empty to keep the current password.

Raw Markdown

Readers of a public project can append .md to the address of a page to get its content as plain Markdown. This also makes your docs easy to feed into other tools. Password-protected projects do not offer this to visitors who have not unlocked them.

If your project is taken offline

In rare cases, for example after a policy violation, a platform administrator can take a project offline. The project then cannot be opened and you cannot publish it again yourself. Contact support if this happens.