02-documents
Documents
Documents are the heart of Kherpi. A document can be anything — a note, a journal entry, a contact card, a recipe — depending on its document type.
The Document List
The main Documents page shows all your documents in a list, sorted by most recently updated. Each document shows its title, document type, folder path, and last modified date.
Searching
Use the search bar at the top of the page to filter documents by title. The search updates as you type.
Filtering by Type
Below the search bar, you'll see type filter chips — one for each document type you've created, plus an "All" option. Click a type to show only documents of that type.
Deleting Documents
Each document in the list has a trash icon on the right. Click it to move the document to the trash. Deleted documents can be restored from the Trash page.
The Document Editor
Click on any document (or click New) to open the editor. The editor is a three-panel layout:
Markdown Editor (left panel)
The left panel is where you write. It's a plain text area that accepts Markdown syntax. A label at the top confirms you're writing in Markdown.
The title field sits above the content area — simply type your document's title there.
Live Preview (middle panel)
The preview panel renders your Markdown content in real time, so you can see exactly how it will look. You can toggle the preview panel on and off using the split-view button in the editor toolbar. Your preference is remembered across sessions.
Properties Panel (right panel)
The properties panel contains metadata and settings for the document:
| Property | Description |
|---|---|
| Pinned | Toggle to pin the document. Pinned documents are highlighted on your public profile. |
| Type | Select the document type. Changing the type updates the available custom properties. |
| Folder | Assign the document to a folder, or leave it at "None" for unfiled documents. |
| Custom properties | Any properties defined on the selected document type appear here (see Document Types). |
| Created | The date the document was created (read-only). |
| Modified | How long ago the document was last modified (read-only). |
| Public URL | If the document is public and published, the URL where it can be viewed (read-only). |
Editor Toolbar
The toolbar at the top of the editor contains:
- Status selector — set the document status to Draft, Published, or Archived
- Public toggle — make the document publicly visible
- NSFW toggle — mark the document as containing adult content
- Save button — save your changes (a "Saved" confirmation appears briefly)
- Delete button — move the document to trash (asks for confirmation)
NSFW Detection
Kherpi includes automatic NSFW content detection. If the system detects that your document may contain adult content, a suggestion banner appears at the top of the editor:
"This document may contain NSFW content."
You can click Mark as NSFW to flag it, or Dismiss to ignore the suggestion.
Uploading Images
Click the image button in the editor toolbar to upload an image. Supported formats are JPEG, PNG, GIF, and WebP. After uploading, a Markdown image tag is automatically inserted at your cursor position.
Unsaved Changes Warning
If you try to navigate away from the editor with unsaved changes, Kherpi will ask you to confirm before leaving, so you never lose work accidentally.
Document Statuses
Every document has one of three statuses:
| Status | Description |
|---|---|
| Draft | Work in progress. Not visible publicly, even if marked as public. |
| Published | The document is finalised. If also marked as public, it appears on your public profile. |
| Archived | Hidden from the main document list but still accessible. |
Making Documents Public
To share a document publicly:
- Set the status to Published
- Toggle Public on in the editor toolbar
- Save the document
The document will now be accessible at your public profile URL. The exact URL is shown in the properties panel under Public URL.
If the document is in a folder, the folder path becomes part of the URL. For example, a document called "my-recipe" in the folder "cooking" would be available at /u/yourname/cooking/my-recipe.