Skip to documentation

Second brain · User guide

Newral, from your first files to your knowledge graph.

Follow the product’s actual path: open a local folder or GitHub repository, write, connect, organise and explore your notes. No Newral account and no proprietary format between you and your ideas.

Web app · Chrome and Edge · .md files

01 / Get started

Start with files you already own.

In Newral, either a local folder or a GitHub repository is your vault.

For local mode, choose Open a local folder and grant read and write access. The folder stays in place and may reopen if the browser keeps its permission.

A vault can also be a private GitHub repository: the same Markdown files, versioned and reachable from several machines. Connecting one, the permissions it asks for, how commits are made and what to do about conflicts are the whole of the next chapter, GitHub sync.

02 / GitHub sync

Open a GitHub repository as a vault, in six steps.

A private GitHub repository replaces the local folder: the same Markdown files, the same features, plus history and access from several machines. Newral talks to GitHub’s API straight from your browser; no note ever travels through a Newral server.

  1. Create a private repository on your GitHub account. New repository, visibility Private. Newral does not create it for you. Leave it empty: it gets initialised on the first save.
  2. In Newral, click “Use with GitHub”. The button sits on the home screen, next to “Open a local folder”, and on the website.
  3. Sign in to GitHub and let Newral identify you. That step alone grants access to no file.
  4. Click “Authorise a repository”. GitHub offers to install the Newral app: pick Only select repositories and tick the repository from step 1. It asks for Contents: Read and write, to read your notes and save your changes.
  5. Back in Newral, pick the repository. Click Refresh if the list is still empty. Each repository shows its default branch, and a padlock when private.
  6. Write. Your changes leave as grouped commits on the default branch, a few seconds after your last keystroke. Nothing else in Newral changes.
Two habits
Edit from one place at a time: if the branch moved elsewhere in the meantime, Newral refuses to overwrite that work and you have to reopen the repository to start from the current version. And wait for the save indicator to settle before closing the tab.

03 / Notes and folders

Create, organise and move things without losing sight of the file.

The sidebar mirrors the selected storage. A note is a Markdown file; a folder remains a folder.

Create notes and folders, rename, duplicate, move, bookmark or send them to the trash from the sidebar and contextual menus. Nothing is erased: the document moves to the trash, from which it returns to its original location. Deleting for good is only offered inside the trash.

Sort the tree by name or modification date. Refresh it after changes made outside Newral, and use Collapse all to close opened folders.

04 / Block editor

Write in a block editor, keep clean Markdown.

The note body is edited visually with Tiptap, then serialised as Markdown. You never need to manipulate syntax in everyday work.

Type / at the beginning or in the middle of a paragraph to open the command menu. It includes text, headings, lists, quotes, code, dividers, tables, images and note links. An image (PNG or JPEG) can also be pasted from the clipboard or dragged in as a file; it is saved in your vault’s attachments folder.

Click the large title to rename a note. Press Enter to confirm or Escape to cancel. Content is saved automatically after typing and the status indicator reports saving progress or an error.

06 / Properties and organisation

Keep useful metadata close to the note.

Tags, dates and other properties are stored in the file frontmatter, so they stay with the note instead of a separate database.

Use tags to group notes in the sidebar. Selecting a tag opens its note list; bookmarks keep important notes within reach.

Newral preserves unknown frontmatter fields, so an existing Markdown vault can remain compatible with other tools.

07 / Tabs and split view

Keep several lines of thought open.

Tabs make it easy to move between notes. Drag one to reorder it, close it when you are done, or open a second workspace alongside the first.

Split view gives the right pane its own tabs and search. Drag a note to the right edge to preview the split destination, or open it there from the contextual menu.

Adjust the divider to give each workspace the space it needs.

09 / 2D and 3D graph

Read the network, then return to the text.

Every note becomes a node and every mention a connection. The graph helps explore neighbourhoods, spot isolated notes and open a document without returning to the tree.

Drag a node, zoom with the wheel and use Recenter to see the whole network again. Hovering highlights a node and its nearby notes.

The 2D/3D switch keeps the same physics and relations. In 3D, the left button rotates the scene, the wheel zooms and the right button pans.

10 / Maps (whiteboard)

Lay ideas out side by side on a whiteboard.

A map is a free canvas saved in your vault next to your notes. Place blocks, move and resize them to map a project without forcing structure onto the text itself.

Create one from the sidebar’s File menu (choose Map), the navigation rail (New Map, under Graph) or the sidebar’s contextual menu. Maps appear in the file tree with their own icon, in search under a Maps group, and can be bookmarked or renamed like notes.

Three block types: a free-text card carrying the same editor as your notes, where you double-click to write, then type / to insert a heading, list, table or image, and cite pages with [[…]] or a note’s exact title; an embedded vault note rendered read-only with a button to open the full note; and a media block: a PNG or JPEG image placed on the canvas from the toolbar, the context menu or by dragging a file, saved in your vault (attachments folder) and referenced by a relative path, just like note images.

The wheel pans and Ctrl + wheel zooms towards the cursor. Dragging a block shows coral guides the moment an edge or centre lines up with another block, and the move snaps to it, just like a design tool. A single toolbar gathers everything: adding blocks, zoom, fit, and a settings menu that switches it between horizontal and vertical, makes it movable (a six-dot grip lets you place it anywhere, otherwise it stays docked), snaps moves to the grid or locks the map read-only. Right-click still adds a block at that spot; right-click a block to open, edit, duplicate or delete it.

A map is a versioned, readable .map JSON file synced like the rest of the vault. A map appears in the graph as a node linked to every note it cites, and page blocks are rewritten when a note is renamed, like wiki links.

11 / Calendar

See what is coming, not only what was written.

The calendar is the vault read forwards, facing the timeline that reads it backwards. Keep several calendars — work, personal, appointments — and they overlay in a single view.

Open it from the calendar icon in the sidebar footer, beside the timeline and the graph; on a phone it is reached from the home header. The first screen offers a single gesture, Create a calendar, and a title is all it needs — two calendars may share one without it being a mistake. Double-click a day, or a slot in the Week and Day views, to open a new event with the clicked time already filled in. Clicking a calendar's name in the legend switches it on or off; switched off, the name recedes rather than disappearing, so you know it still exists.

Month, Week and Day share the day you are looking at: changing scale does not send you back to today. A cell keeps the same size from one scale to the next — heights are minimums, so the grid fills the window when there is room and scrolls when there is not, without ever squashing an hour. The hour views do not show twenty-four empty hours: they show working hours and extend by themselves until they contain whatever your days actually hold, so a 5 a.m. flight cannot be hidden. A marker shows the current time.

Dragging an event moves it from one day to another keeping its duration, even across midnight. Dragging its top or bottom edge changes that bound alone. Both gestures snap to the quarter hour, and nothing is written to the file until you let go. Double-click opens an event — never a single click, which belongs to dragging — and right-click offers Edit and Delete. Several events at the same time share the width of the day, per overlapping cluster: an eight-hour meeting does not shrink the evening slots that cross nobody.

Colour belongs to the EVENT, not to the calendar: a slot is blue because of what it is, not because it came from Work. Seven hues are offered, chosen to stay readable on their own background in both themes; coral is not among them, staying reserved for the interface's primary action. An event's form searches your vault and references notes by TITLE, like a wiki link, so moving the note breaks nothing.

A calendar is a versioned, readable .calendrier JSON file stored in .newral/calendriers/. It therefore appears neither in the file tree nor in search: you open it from the Calendar view, not from the vault tree. It does appear in the GRAPH, as a node linked to every note its events cite, and in those notes' Linked notes panel — clicking it there returns to the Calendar view. Moving one to the trash works like any other document and it returns exactly where it came from. A file that is unreadable, or written by a newer version of Newral, is flagged and never rewritten. Recurring events are not handled yet: each occurrence is its own event.

12 / Data and compatibility

Know exactly where your data lives.

Newral has no note-storage backend or Newral account. Local mode uses File System Access; GitHub mode talks directly to GitHub’s API.

File names carry note titles; frontmatter contains creation dates, tags and preserved custom fields. Workspace preferences live in .newral/config.json inside the selected folder or repository.

Newral’s Vercel Functions handle GitHub authentication and temporary tokens only. Note content travels directly between the browser and GitHub, and concurrent branch changes are never force-overwritten.

13 / Keyboard shortcuts

Visible commands before they become muscle memory.

Search, editing and the global actions all respond to the keyboard. The Note, Folder and Tab combinations include Alt: browsers reserve the bare variants (⌘ N, ⌘ W…) for their own windows and tabs.

  • Ctrl KOpen or close global search
  • Ctrl Alt NCreate a new note
  • Ctrl Alt ⇧ NCreate a new folder
  • Ctrl \Open or close split view
  • Ctrl GOpen the graph
  • Ctrl Alt WClose the active tab
  • /Open the block menu in the editor
  • [[Choose or prepare a linked note
  • ↵ / EscConfirm or cancel a title rename

End of the guide

Your files are the source of truth. Newral is the workshop around them.

Create