Reference the user interface (UI) of pages in Reunite's project workspace. Learn about the various ways you can utilize the interface controls.
All project workspace pages have:
- (1) navigation pane
- (2) top bar
Use the navigation pane to:
- (1) access the organizations and projects menu
- (2) collapse the navigation pane
- (3) switch between Reunite workspace pages
- (4) view the latest product announcements
- (5) access the user profile menu
Use the organization and projects menu to:
- (1) create a new organization
- (2) switch between organizations
- (3) return to the organization's Overview page
- (4) switch between projects
- (5) create a new project
The Editor page is the part of Reunite's project workspace where you add, edit, and manage the content of your project. The page has two main areas:
- the file tree pane
- the editor pane, which contains both file tabs and utility tabs (Webview, Documentation)
To best suit your experience, you can resize the file tree pane, collapse it, and reorganize the editor pane by splitting and rearranging tabs.
The file tree pane has three tabs:
- files tab with Theme components pane
- search tab
- commit tab with History pane
The files tab displays the file tree of your project, including remote files. Use this tab to add, modify, or delete files, as well as eject your project's theme components.
In this tab you can:
- (1) add new content:
- (2) manage files and folders
- (3) browse, eject, and customize theme components
Use the search tab to lookup text or files in your project.
In this tab you can:
- (1) expand or collapse the Replace with field
- (2) search file content
- (3) find files by name
- (4) filter search results by folder
- (5) toggle case matching
- (6) toggle whole word search
- (7) toggle regex search
- (8) replace all results
The commit tab lists all changes to files since the last commit. Use this tab to commit changes, open pull requests, revert uncommitted changes to files, and view the commit history.
In this tab you can:
- (1) commit latest changes to the current branch
- (2) create a pull request
- (3) revert changes to selected files
- (4) view commit history relative to the main branch of the project
The editor contains the tabs that display the content you are working with. Every open file opens as a tab, and utility views such as the Webview live preview or Redocly documentation open as tabs in the same pane. You can rearrange, split, and close any of these tabs to build the layout that best fits your workflow.
Each tab group header includes a + icon that opens the start tab.
The start tab lets you:
- open recent files
- search files by name
- open utility tabs from the Tools section
File tabs display the content of files from your project. When you single-click a file in the file tree, the file opens in a preview tab with its name shown in italics. If you single-click another file, the new file replaces the preview tab. To keep a file open, double-click its tab or start editing the file. This converts the preview tab into a regular tab.
You can open two utility tabs in the editor dock:
- Webview - displays a live preview of the opened Markdown or API description file. See Use the Webview for details.
- Documentation - displays Realm documentation with full capabilities of a Redocly project.
To open a utility tab, either:
- Click the More actions icon on the right side of the tabs header and select Open Webview or Open Documentation.
- Use the keyboard shortcut for the tab you want. See the keyboard shortcuts reference for the full list.
- Open a start tab and select a tool from the Tools section.
If a utility tab is already open, triggering the open action activates the existing tab instead of creating a duplicate.
The Webview live preview tab renders the currently open Markdown or API description file as it would appear in a published project.
- (1) navigate to previously opened pages
- (2) reload webview
- (3) view the slug to the file displayed in the webview
- (4) switch the view between screen sizes
- (5) open webview in a new browser window or tab
- (6) use the More actions menu to:
- (7) display webview build validation errors
- (8) display the number of pages in the project
- (9) view webview build logs
The docs tab displays Realm documentation with full capabilities of a Redocly project.
In this tab you can:
- (1) search the content
- (2) navigate the pages
- (3) change the color mode
- (4) open the displayed page in a new window or tab
- (5) interact with pages
Right-click any tab to open the tab context menu and choose one of the following actions:
- Close - close the tab.
- Close others - close every other tab in the same group.
- Close to the right - close the tabs to the right of the current tab in the same group.
- Close unchanged - close every file tab in the group that has no uncommitted changes.
- Close all - close every tab in the group.
- Copy path - copy the file path of the tab to the clipboard (available for file tabs only).
- Split right, Split left, Split up, Split down - move the tab into a new group positioned relative to the current group.
You can also drag a tab by its header and drop it on the edges or center of another group to move it, or onto the middle to create a new group.
The More actions icon on the right side of each tabs header provides group-level shortcuts to:
- Close all or close unchanged tabs in that group.
- Set default 2-pane editor layout.
- Open the Webview or Documentation utility tab.
- Toggle word wrap for the active editor tab (when a text file is active).
- Reunite - Learn about Reunite's features
- Reunite user profile menu - Step-by-step instructions setting up notifications, color mode, and a Git provider account
- Use the Webview - View live previews of your content changes while editing for immediate visual feedback
- Use the editor - Learn to edit content in Reunite's integrated editor with syntax highlighting and collaborative features