Cratly Editor
Zu Deutsch wechselnDE

Introduction ​

This guide walks through setting up and using the Cratly editor with your GitLab repository.

Prerequisites ​

  • A GitLab account (gitlab.com or a self-hosted instance)
  • A repository containing Markdown files you want to edit
  • An OAuth application registered in GitLab (see Connecting a Repository)

How it works ​

Cratly uses the GitLab API over OAuth 2.0 with PKCE. All requests go directly from your browser to GitLab — there is no intermediary server. Your access token is stored only in your browser's session storage and is never sent anywhere else.

When you save a file, Cratly creates a commit on the repository branch you are working on. If the repository has a CI/CD pipeline, it will run as usual.

  • Pages tab — the file tree of Markdown files in your repository
  • Media tab — images and other assets
  • Editor — the main editing area; click any file in the tree to open it
  • Front matter — YAML metadata panel, toggled via the toolbar
  • Branch selector — switch branches or open a merge request from the header

Continue to Connecting a Repository →