Skip to content

About

A private Markdown library for TREK with explicit trip sharing, live references and frozen travel copies.

Topics

Resources

Stars

2 stars

Watchers

0 watching

Forks

Latest commit

 

History

10 Commits

Folders and files

Repository files navigation

Fieldnotes

English | 简体中文

Write it down once. Have it on every trip.

Fieldnotes is a private Markdown library inside TREK, the self-hosted trip planner. Keep how to get around a city, how to behave at a temple or which apps are worth installing in your own library, then bring the right notes into each trip as live references or snapshots.

Works with TREK 4.1 or later; add Trip Fieldnotes to read notes in trips · Actively maintained, see Releases · MIT licence

Screenshots

Fieldnotes: the library in columns in the light theme in Safari on a MacBook, with the same note in the dark theme on an iPhone in front

What it does

The notes built into TREK belong to a single trip. Fieldnotes keeps your notes in one library you own and reuse across trips: a Yunnan transit cheat sheet written once can sit in every trip there, and still follow your edits. Unlike notes kept in Notion or Obsidian, they stay on your TREK server, and your travel companions read them inside the trip they are planning.

On its own, Fieldnotes is your library. To read notes inside a trip, add its companion Trip Fieldnotes, which gives every trip a notes tab; Fieldnotes keeps the notes, Trip Fieldnotes shows them.

Writing

The editor is built on Markdown and follows the conventions of common Markdown editors: what you write is always plain text, and what you see is the formatted result.

Live rendering
Headings, lists, tables, quotes and links are shown formatted as you type. Markdown symbols appear only where the cursor is, so they are there when you edit and out of the way when you read.

Slash menu
Type / on an empty line to insert a heading, to-do list, bulleted list, quote, divider, image or PDF. Each entry shows the Markdown it stands for, so you can type it directly once you know it.

Keyboard shortcuts
⌘B bold, ⌘I italic, ⌘E inline code, ⌘⇧X strikethrough, ⌘K link, ⌘1–⌘6 heading levels, and ⌘0 back to plain text. Use Ctrl on Windows and Linux.

The editor: a note with folded properties, headings, a tip callout and a table, shown formatted while editing

🖼️ Images saved with the note
Paste a photo or drop it into a note. It is compressed in the browser (longest side at most 2560 pixels; GIFs are kept as they are, so they still move) and saved with the note on your TREK server, so it still shows if the original website goes away.

🔗 Links between notes
Type [[ and pick a note to link to it, or add # to link one of its headings. Links keep working after the note is renamed. Each note lists the notes that link to it, with the line that mentions it, and below them the notes that name it without a link, ready to be linked in one click.

🧩 Notes inside notes
Put ![[ on a line of its own to show another note, or one of its sections, right there. It always shows that note as it is now, so a transport cheat sheet written once can sit in every city guide.

💾 Automatic saving
Edits are saved as you type, and a short notice at the bottom says so. A note can run to 200,000 characters. ⌘Z and ⌘⇧Z undo and redo only your own changes, never those of people editing with you.

🕘 Version history
Fieldnotes keeps a version each time editing pauses: every one from the last day, one a day for a month and one a week for a year. Open any of them to read it and restore it if you need it back; the text it replaces is kept as a version too.

📄 PDFs you can read in place
Drop in a booking confirmation, a ticket or a museum map, up to 10 MB. It reads right inside the note, a page at a time, or every page at once in a full view. Like images, it is saved with the note on your TREK server.

💡 Callouts
Write > [!tip], [!warning] or [!danger] to turn a quote into a tinted box for the things not to miss, the way Obsidian does. Add - after the type to fold it until it is needed.

🧭 Outline
A long guide gets an outline button. It lists the headings, and choosing one takes you straight there.

⚡ Quick open
⌘O lists the notes you opened last and finds any note as you type. Start with > to run a command, or # to jump to a heading of the note you are reading; ⌘K opens the commands directly.

Organising

The library in columns: folders, sub-folders and notes, with the chosen note previewed on the right

Folders
Organise notes in folders and sub-folders, as deep as you need, and browse them in columns as in the Finder: one click previews a note, a second opens it. The columns grow with the window, from a laptop to a 27-inch display, and always fit on the page. Drag a note onto a folder to move it, or choose Move to… from its menu, which works on a phone too; folders move the same way. Command-click or Shift-click several notes to move or delete them together, and drag the line between two columns to make them wider. A folder can only be deleted once it is empty, so no note is lost by accident.

Icons
A folder can have an emoji or an icon of up to 8 characters. A note can have an emoji or an uploaded image, which is cropped to a centred square.

Two libraries
Every note and folder sits in one of two libraries. The private library holds your own notes and the ones others share with you; the public library holds what everyone signed in to your TREK can read, and you write and arrange there as you do in the private one. To move something across, drag it onto the other library's tab or change its visibility: everything inside it that you own goes along.

Recently deleted
Deleting a note asks nothing: the notice that follows has Undo, as the Finder moves a file to the Trash. A deleted note waits at the foot of its library for 30 days, images and history included, ready to be recovered where it was; each library keeps its own, so a public note is found in the public one. Delete it permanently from there when you are sure. Removing a note from the library never touches a trip’s snapshot of it: that copy belongs to the trip.

Recently deleted: a deleted note in preview, with the date it will be deleted permanently, Recover and Delete Permanently
Note properties: three cities, a status and a tag, a checklist at 67 percent, and a link for tickets

Properties
As in Notion, each note can have up to 30 properties of nine kinds:

  • Text, number, date, URL and checkbox
  • Select and multi-select, shown as coloured labels, for things like a city or a status
  • Checklist, with up to 50 items and its progress worked out for you
  • Last edited, which updates by itself

URL properties open in a new tab, and property values are included in search.

🔍 Search
Search covers wherever you are: all notes from "All notes", or just one folder once you open it. A note must hold every word you type; ones with it in the title come first, and the rest show the passage that matched.

↕️ Sorting
Sort by name, creation date or last change, ascending or descending. Names compare numbers by value, so "Day 2" comes before "Day 10". Your chosen order is remembered for next time.

📥 Bring your notes in, and take them out
Right-click an empty part of the library to import an Obsidian vault, a folder or a ZIP of Markdown. Its folders come too, front matter becomes properties, links between the notes keep working, and the images and PDFs they use are uploaded with them. Everything lands in a new folder named after what you imported. To take a note elsewhere, right-click it and choose Copy as Markdown: its properties come along as front matter and its links as ordinary [[titles]].

Sharing

The Sharing window of a note: private visibility, four collaborators, and the two trips it is in, one live and one as a snapshot

Editors and viewers
You can invite people who share a trip with you to a single note or to a whole folder. Editors can change the content with you; viewers can read it.

Folder access carries down
Access given to a folder applies to every note and sub-folder inside it, which makes it easy to share everything about a country or a whole trip at once.

Saved together
Role changes and new people take effect when you save them, and closing the dialog with unsaved changes asks for confirmation first.

🔒 Private by default
A new note is visible only to you until you invite someone, make it public, or bring it into a trip.

🌐 Public notes
A note or folder moved to the public library can be read by everyone signed in to your TREK. Private folders above it become public too, after Fieldnotes names them and asks, but only their names show; what else they hold stays private.

👤 What only the owner decides
Editors can change the content. Who can see the note, which folder it is in, and whether it can be shared live with a trip are decided by the owner.

Co-editing

One shared document
When several people open the same note, they edit one shared document. Each person has a colour, and everyone else shows up right in the text as a cursor with their name beside it.

Changes merge
Everyone's changes are merged automatically, so nobody has to wait for anyone else and there is no "this note was changed by someone else" conflict. Titles, properties and icons can be edited together as well.

Connection drops
If the connection drops briefly, edits are kept locally and synced when it returns. If an editing session stops for any reason, the editor says why, and "Rejoin" continues from the latest version.

Bringing notes into a trip

A note can be brought into any number of trips, each time as a live reference or as a snapshot.

Live reference Snapshot
What the trip shows The note's current version The version from when it was added
Your later edits Appear in the trip Do not change the snapshot
Images Shown from the original note Copied into the snapshot
After you delete the original No longer shown Kept
After you leave the trip Private notes no longer shown Kept
Good for Guides and checklists you keep updating Information that should stay exactly as it was, such as details you confirmed before leaving
In trips: the note is a live reference in Spring in Yunnan and a snapshot in Seoul Weekend

How to add a note
Open a note's sharing window and, under "Bring into a trip", choose the trip, an optional day and the sharing mode. A private note someone else shared with you can only be added as a snapshot; sharing it live is the owner's decision.

In trips
The same window shows the owner which trips a note has been added to, and jumps straight to that trip's tab. A live reference can be removed from there; a snapshot is the trip's own copy, so it is removed from the trip's page.

Linked to a day
When adding a note, you can pick a day of the trip; the note then shows that day in the trip.

Discussed in the trip
Trip members can comment on a shared note, on the whole note or on a passage they select. Those comments belong to that trip and are not shown in your library.

A trip's Trip Fieldnotes tab: notes and a trip folder in columns, with a snapshot previewed and pinned to day 5

AI assistants

An AI assistant connected to TREK can use the list_trip_notes tool to read the notes shared with a trip you can access, and answer questions such as "How do we book the train from Kunming to Dali on this trip?". It reads with your permissions, cannot see trips you have no access to, and cannot change anything.

Other details

🌍 Languages
The interface and error messages follow TREK's language setting, in 28 languages: English, Simplified Chinese, Traditional Chinese, Japanese, Korean, Thai, Vietnamese, Indonesian, German, Spanish, Catalan, French, Italian, Dutch, Brazilian Portuguese, Swedish, Estonian, Hungarian, Czech, Slovak, Polish, Ukrainian, Russian, Greek, Turkish, Azerbaijani, Arabic and Hebrew, with a right-to-left layout for Arabic and Hebrew.

📝 Nothing lost by leaving
Notes save as you type, so you can leave one at any moment. The one exception is a new note you have started but not yet created: if you have typed into it, Fieldnotes asks before you leave.

⚠️ Error messages
When something fails, the reason is shown, such as "A folder with this name already exists here" or "This note changed. Reload before saving.", rather than a status code.

🗄️ Where data lives
Notes, folders and images are stored on your own TREK server, in Fieldnotes' own database, never with a third-party service.

🌐 Images from other websites
Images linked from other websites are fetched by your TREK server, so readers' browsers never contact those sites. Until an administrator allows a site, its images show why they cannot load.

📦 Images in snapshots
Taking a snapshot copies its images. An image from another website that cannot be fetched at that moment is skipped rather than blocking the snapshot.

Permissions

Fieldnotes keeps your notes, folders and images to itself and only asks TREK for what the features above need. It always acts as you, so it can never see a trip you are not part of or change one you are not allowed to edit.

Permission What it is used for
db:own Saving your notes, folders, sharing choices, trip links, snapshots and pasted images.
db:read:trips Showing your trips and their days when you add a note to a trip, suggesting people to share with (the members of trips you are on), and reading a trip's places, bookings and stays for the trip items a snapshot shows as cards.
db:read:files Finding images that come from files attached to a trip.
db:read:files:content Displaying those images and keeping a copy of them in snapshots.
db:meta Checking that you are allowed to edit a trip before you add, remove or arrange its notes.
db:read:users Showing who else is editing a note with you.
hook:user-data Including your notes when you export your TREK data, and deleting them when your account is deleted.
mcp:tools Letting an AI assistant connected to TREK read the notes shared with a trip you can access. TREK shows this as "Publishes AI tools".
http:outbound Showing images that a note links from another website. This stays switched off until an administrator allows that website, and private network addresses are always blocked.

Setup

  1. As an administrator, open Admin → Plugins in TREK. Find Fieldnotes and Trip Fieldnotes under Discover and install them, or download their ZIP files from the Releases page of each repository and install them with Upload plugin.
  2. Turn on Fieldnotes first and Trip Fieldnotes second. New plugins start switched off.
  3. Open Fieldnotes from the navigation bar and write your first note. To share it with a trip, open the note's Sharing window and use Bring into a trip.

Warning

Uninstalling Fieldnotes deletes every note, folder and image it stores. Back up TREK before you uninstall it. Updating to a newer release keeps everything.

Optional: notes can show images linked from other websites once you allow those websites in Admin → Plugins → ⋯ → Allowed hosts on Fieldnotes, for example *.example.com. Copying an image and pasting it into the note always works without any setup.

Good to know

  • Who can read my notes? Only you, until you invite someone, make the note public, or add it to a trip. A live reference is visible to everyone on that trip.
  • Do I need Trip Fieldnotes? For the full experience, yes. Without it Fieldnotes still brings notes into trips, but no one can read them there, and Open in Trip Fieldnotes shows the trip's plan instead.
  • What happens if I leave a trip? Your private notes that the trip followed as live references are no longer shown there. Snapshots stay, because the trip received them as copies.
  • Where are my notes kept, and can I take them with me? In Fieldnotes' own database on your TREK server, never with a third-party service. They are included when you export your account data from TREK. To take a single note elsewhere, right-click it and choose Copy as Markdown: its properties and links come along.
  • What does it not do? There is no offline app and no two-way sync with Obsidian or Notion: importing brings notes in once, and Copy as Markdown takes one note out.

For developers

The ready-to-install plugin sits at the top of this repository. Its source code and tests are in source/, which also builds Trip Fieldnotes; that is where changes are made.

cd source
npm ci
npm test         # server, client and translation tests
npm run export   # rebuilds the plugin files here and in the sibling fieldnotes-trip checkout

License

MIT

About

A private Markdown library for TREK with explicit trip sharing, live references and frozen travel copies.

Topics

Resources

Stars

2 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages