Skip to content
Get started

Project page and settings

Every project has a project page with an overview, its files, history, branches, pull requests, discussions, members and settings. Click a project on the dashboard to open it.

The header shows the project’s name, its accent colour, your role and the description. It has two buttons:

  • Open in editor opens the project in the editor. If the project has several branches, Luzbase first asks which Branch to open.
  • Save as template saves the project’s files as a template you can start new projects from. Viewers don’t see this button. See Use a template.
Tab What it shows
Overview The project’s README, open pull requests, details, members and languages
Documents The files of a branch at its last saved version, read-only. See Download and export.
Branches Every branch and how far ahead or behind main it is. See Branches.
History Saved versions, with their files and comments. See Version history.
Pull requests Proposals to merge one branch into another. See Pull requests.
Discussions Project conversations. See Discussions.
Members Who has access, with their roles. See Invite collaborators and Manage members.
Settings Project settings, described below
  • About shows the README.md file at the top level of the default branch. If there is none, Owners and Editors can click Add one in the editor and create a README.md there. Use it to explain what the project is and how it’s organised.
  • Open pull requests lists pull requests waiting to be merged.
  • Details shows when the project was created, its default branch, its number of documents and members, and the template it was created from, if any.
  • Members shows who has access.
  • Languages shows which kinds of files make up the project.

Rename a project or change its accent colour

Section titled “Rename a project or change its accent colour”

You need to be the project’s Owner or an Editor.

  1. Open the Settings tab. It opens on General.
  2. Edit Project name or Description, or pick a different Accent colour.
  3. Click Save changes.

Luzbase shows Settings saved. If you leave the page without saving, Luzbase asks whether to Discard and leave or Keep editing.

Page What it’s for Who sees it
General Name, description and accent colour Everyone; Owners and Editors can change it
Branches & merging Protecting main, required approvals, deleting merged branches. See Merge settings. Everyone; only the Owner can change it
References Zotero and Mendeley sync. See Zotero. Everyone
Export & templates Download the source as a .zip, save as a template. Viewers see Export. See Download and export. Everyone
Archive & delete Transfer ownership, archive or delete. See Archive and delete. Owner
Leave project Remove yourself from the project. See Manage members. Editors and Viewers

There is no setting for the main file or the compiler. See The main file.

When a project is archived, every tab shows a banner: “This project is archived. It is read-only — nothing can be edited, committed or compiled.” The Owner can click Unarchive in the banner. See Archive and delete.