Moment docs are plain-old Markdown files stored in a Git repository on your device. In this guide, we will create a Moment doc, apply basic text formatting, commit the changes with git, and inspect the underlying Markdown files as they exist on your local device storage.
Create a new Moment doc
After you download, install, and run the Moment desktop app, you will see a screen like the following. Click either of the New Document buttons.
Once done, you will see an empty Moment doc:
Add and format some text
Moment docs are ultimately Markdown files, and they support Markdown syntax natively. See the Editing and formatting reference for more details.
Try the following to put the editor through its paces:
Initially, the Untitled placeholder at the top of the page will be selected. Type text to add a title to the page, and press Enter to focus the (currently empty) page contents.
Type some text into the editor. In the example below, we’ve typed Here is some test text!.
To create a heading, type a # followed by a space. For example, # My first heading in the example below.
Highlight some text to open the rich text toolbar. You can use this to make text bold, italic, strikethrough, block quote, bullet lists, and so on.
Commit your changes
Once you have added some text, click the Commit draft button in the bottom left.
This will bring up the commit modal. To commit changes, enter a commit message in the field in the upper left, then click Commit to main. In the following example, we’ve added the commit message My first commit.
💡 What is all that stuff in the commit UI? For a more detailed explanation, consult the
Committing changesguide!
Once committed, you can press Escape or click the close button in the upper right to dismiss the modal and go back to editing the Moment doc.
Inspecting the files on disk
Because Moment docs are plain-old Markdown files stored on your device, we can inspect and interact with them as we do with any other files. To do this, click the overflow menu in the upper left next to the Moment doc title. You will see two options:
Reveal document on filesystem…, which opens the Moment doc folder in the relevant OS file explorer (e.g., macOS Finder), and
Copy path to document folder, which copies the path to the directory for use in, e.g., a Unix terminal.
Clicking either of these will allow you to inspect the document, for example, as follows:
Next steps
Try adding some interactive components.