riteDocumentation
DocumentationAPI reference
Getting Started
Introduction
Concepts
Usage Guide
Navigation
Introduction
Dashboard
Command Palette
Content Editing
Writing in the Vrite Editor
Managing metadata
Configuring Vrite
Publishing content
Vrite Extensions
JavaScript SDK
Introduction
Self-Hosting
Docker
Configuration
Ask
Type to search
Navigation

Introduction

Given that Vrite is an open-source project, you can get started by either self-hosting it or using the Vrite Cloud instance (it’s free while Vrite is in Beta).

Sign In

Whatever way you choose to use Vrite, you’ll be first met with the sign-in page. Here you can do one of the following:

  • Sign up by clicking I don’t have an account and providing your new username, in addition to a unique email and password; You’ll be sent a link to confirm your email address and finalize the process.
  • Sign in or sign up via GitHub by clicking the GitHub button and going through the OAuth process;
  • Sign in using the email and password form;
  • Sign in using the Magic Link, by providing an email to which a sign-in link will be sent to. It’s also useful when you forget your password (once you’re in, you can change it in the settings).

Vrite sign-in page

To easily navigate around Vrite, you need to get to know the 3 main parts of the UI:

  • Sidebar - used to navigate between different sections of the UI;
  • Side panel - where most side activities like configuration, metadata editing, and team management take place; You can easily resize or even collapse it entirely by dragging its right-side border;
  • Main view - the largest area of the viewport, focused primarily on content management (via Kanban dashboard) and editing (in the WYSIWYG editor);

The sidebar is used as the primary means of navigation around Vrite UI. It’s visibly separated into two sections.

Top section - Contains the options that let you navigate both the main view and the side panel:

  • Dashboard — Takes you to a Kanban dashboard and opens a metadata side panel (if a content piece is opened);
  • Editor — Takes you to the Vrite editor and opens the metadata side panel, loading the opened content piece in both;

Bottom section - Contains options for navigating the side panel or going to other parts of Vrite UI.

  • _Source control _— Opens the Git sync side panel;
  • Settings — Opens the settings side panel;
  • Extensions — Opens the extensions side panel;
  • Switch Workspace — Navigates to Workspace selection menu;
  • Profile — Open the profile dropdown displaying details of the signed-in user and other options;

Profile menu contains useful information and options like:

  • Profile card - Displays user’s profile image and username, alongside a Logout button;
  • Help - Opens the Welcome side panel with helpful links;
  • GitHub and Discord - links to Vrite repository and community on respective platforms, for quickly getting help or reporting bugs;

Vrite profile menu

Using Workspaces

The Workspace selection menu allows you to switch between different workspaces.

Workspace switching menu

From here you can see a list of all the Workspaces you’re a member of, with recognizable information like their name, logo, and your role in them.

You can also create a new one by clicking the New Workspace button in the top-right corner.

Creating a new Workspace

Provide a name for the new Workspace and optionally a description and a logo. Then click Create Workspace in the top-right corner and select the newly-created Workspace from the list to switch to it.

Concepts
Dashboard