Documentation
Guides for Scaffold: vaults, linking notes, the graph, canvas, properties, search, themes, plugins, sync, publishing and Android.
Written for the first public build
These pages describe how Scaffold works and how it is designed to work. Scaffold has not been released yet; where a feature is still planned, its page says so. Nothing here describes a service, because there is none.
New here? Start with Getting started, then read aboutvaults and linking notes. Everything is a plain file in a folder you own, so you can stop reading at any point and just write.
Getting started
- Getting startedInstall Scaffold, create your first vault, write a note, link it to another and find your way around the workspace.
- VaultsWhat a vault is, which files Scaffold reads and writes, how saving stays safe, and how to back up or switch vaults.
- Plan your dayUse the planner in a few minutes - the Today page, the calendar, the Inbox, repeating events, habits, reminders, meeting links, emoji icons and .ics import.
Writing and linking
- Linking notesConnect notes with wikilinks, aliases, heading and block links, embeds and tags, and how Scaffold resolves and updates them.
- BacklinksSee every note that links to the current one, find unlinked mentions, and read your outgoing links and outline.
- Properties and BasesGive notes typed properties with YAML front matter, then view them as tables, lists and cards with Bases.
- Daily notes and templatesOpen today's note with one key, step through days, and write reusable templates with date, time and cursor variables.
- Template galleryInstall a ready-made project tracker, CRM, habit tracker, meeting notes, OKRs or reading list into any folder. Nothing is downloaded.
- Rich blocksToggles, callouts and embeds in plain Markdown, including web embeds that load nothing until you click.
Views
- Graph viewExplore how your notes connect with the global and local graph, and tune filters, colours, node sizes and forces.
- CanvasArrange notes, images and free text on an infinite board and connect them. Boards are saved as open JSON Canvas files.
- SearchFind notes fast with plain words, exact phrases, operators for path, tag, file and section, property filters and regular expressions.
- DatabasesTurn a folder of notes into a database with table, board, gallery and calendar views. Every value is plain frontmatter.
Customise and extend
- Themes and CSSChange colours, fonts, density and layout in Settings, then go further with your own theme and CSS snippets.
- PluginsHow plugins extend Scaffold, the permission model that keeps them contained, and what is and is not available.
- Keyboard shortcutsThe default shortcuts for navigation, notes, views and panels, and how to rebind any command.
Your files
- Sync your notesScaffold has no sync service. Keep devices in step with the folder-sync tool you already trust, and avoid the common pitfalls.
- Publish your notesExport notes as a self-contained static website you can host anywhere. There is no publishing service.
- Import and exportOpen any folder of Markdown files as a vault, import a copy without overwriting anything, and take your data out any time.
Platforms and help
- AndroidInstall the Android preview, where it stores your vaults, what is different on a touchscreen, and what it does not do yet.
- TroubleshootingFixes for install warnings, vaults that will not open, missing notes, stale search, sync conflicts and plugins that do not run.
- UpdatesHow Scaffold updates itself from version 0.2.0 on, what the optional daily check sends, and the one-time step for anyone still on 0.1.x.