Use this document as a reference for 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) 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 three parts:
- the file tree pane
- the editing pane
- the webview pane
To best suit your experience, you can adjust the size of the panes or collapse the file tree or the webview pane.
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
Reunite editor's webview pane contains two tabs. The Webview live preview tab displays the changes to your project in real time. The Docs tab displays Realm documentation.
If you close a tab, you can reopen it by clicking the plus icon on the right side of the tabs.
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
- 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