Your highlights as Markdown
Where Boeks keeps your highlights and notes, what the file looks like, and how to edit it in any Markdown or text editor.
Published
Boeks keeps each edition's highlights, notes, and bookmarks in a Markdown file next to its EPUB, Edition.md. There's no export step: the file is always there and up to date, and edits you make to it come back into Boeks.
Where it is
Each edition of a book has a folder of its own in the book's folder, like Ebook or Ebook (nl), and Edition.md is in it, beside the EPUB. Each edition has its own, since a highlight belongs to one edition's text. The name never changes, so it doesn't have to follow a renamed book.
What it looks like
## Annotations
> [!green]
> He who controls the spice controls the universe.
^01j9xm0c2h7d8f3g4j5k6p7mnb
Herbert means oil, really. Compare [[The Prize]].
> [!bookmark]
> Arrakis teaches the attitude of the knife…
^01j9xq8b1c4d7e0f3g6h9j2kmn
Each highlight is a callout, a common Markdown extension. Its type is the highlight's color (yellow, green, blue, pink, or purple) or bookmark, and its text is the quote. Then comes the highlight's ID, so other notes can link to it, and then your note, in Markdown.
They're in reading order. Chapter titles, page numbers, and dates aren't in the file: page numbers differ between editions, and the dates are in your library's logs.
Edit it anywhere
Open the file in any Markdown or text editor, and Boeks picks up what you change:
- Edit a note, and it changes in Boeks.
- Change a callout's color, and the highlight changes color.
- Change a highlight's quote, and it covers the new words: add words to extend it, remove some to shorten it.
- Delete an entry, and the highlight is deleted.
- Add an entry without an ID, and Boeks finds its quote in the book and adds it as a highlight.
Text outside the entries is yours, and Boeks leaves it as it is.
The book's file
Next to it, Book.md holds the book's status, rating, collections, and review, as frontmatter and a ## Review section. Change them there and Boeks does the same.