Hermes Markdown Documentation

Welcome to Hermes Markdown! This guide will help you get the most out of the app, from writing and organizing notes to exporting and customizing your workspace.

Getting Started
Editor Features
Table Editor
Zen Mode
Exporting to PDF & Markdown
Find & Replace
Templates
Timer
Keyboard Shortcuts
Feature Overview
Privacy & Security

Getting Started

New File: Start with a blank markdown file for total flexibility.
Templates: Use pre-built templates for common note types (e.g., book tracker, dashboard, etc.).
Import: Bring in existing .md or .txt files to continue editing.

Choose your path from the welcome screen or the file menu. You can always switch between these options as you work.

Editor Features

Live Markdown Editing: Write and preview markdown in real time.
Font & Size Customization: Choose your preferred monospace font and font size for the editor.
Metadata Editing: Edit file name, title, description, and tags via the document properties dialog.
Autosave & Change Tracking: Your work is automatically saved, and unsaved changes are clearly indicated.
Sidebar & Mobile Support: Responsive design for desktop and mobile, with collapsible sidebar.

Table Editor

Create and edit markdown tables with ease using the Table Editor. This powerful tool provides an intuitive interface for building well-formatted tables without having to write markdown syntax manually.

Create New Tables: Start with a blank table and add rows and columns as needed.
Edit Existing Tables: Import existing markdown tables and modify them visually.
Add/Remove Rows & Columns: Dynamically adjust table structure with simple controls.
Inline Cell Editing: Click any cell to edit its content directly.
Automatic Markdown Generation: Tables are automatically formatted with proper markdown syntax.

Access the Table Editor from the sidebar, mobile menu, or use the keyboard shortcut ⌘/Ctrl + Shift + T.

Zen Mode

Focus on your writing with Zen Mode. This mode centers the editor, hides distractions, and provides a clean, immersive writing experience. Toggle Zen Mode using the floating button in the editor or press Esc to exit.

Exporting to PDF & Markdown

Export to PDF: Click the PDF icon or use the shortcut to preview your document as a PDF and export it. The export uses a clean, print-friendly style.
Export as Markdown: Use the file menu to export your work as a .md file, preserving all metadata and formatting.

Find & Replace

Quickly search your document using the floating FindBar (Cmd/Ctrl+F), or open the Find & Replace modal for advanced options. Navigate between matches and replace text efficiently.

Templates

Jumpstart your notes with Templates. Select from a variety of pre-built templates for common use cases, or create your own. Templates include structure and sample metadata to help you get started faster.

Timer

Boost your productivity with the built-in Timer. Configure your preferred duration, start, pause, and reset as needed, and receive notifications and sounds when your session ends. The timer can be minimized or closed as needed.

Starting & Pausing: Use the play/pause button on the timer to start or pause your current session at any time.
Resetting: Click the reset button to restart the current interval from the beginning.
Configuring Duration: Open the timer settings (gear icon) to set a custom duration for your session.
Location: The timer is accessible from the main workspace toolbar. On mobile, it appears at the bottom of the screen for easy access.
Notifications & Sounds: When a session ends, you'll receive a notification and a sound alert (if enabled). Make sure your browser allows notifications and sound for the best experience.
Minimizing & Tracking: You can minimize the timer to keep it out of the way while working. The app tracks your current session's progress.

Keyboard Shortcuts

⌘/Ctrl + Shift + Y: Export
⌘/Ctrl + Shift + I: Import File
⌘/Ctrl + Shift + U: New File
⌘/Ctrl + Shift + E: Export to PDF
⌘/Ctrl + Shift + M: Select Template
⌘/Ctrl + Shift + T: Table Editor
⌘/Ctrl + Shift + H: Go to Home/Dashboard
Esc: Close Dialogs or Exit Zen Mode
Cmd/Ctrl + F: Open FindBar

Feature Overview

Live Markdown Editor with real-time preview
Table Editor for creating and editing markdown tables
Zen Mode for focused writing
Export to PDF and Markdown
Find & Replace with floating FindBar
Pre-built and custom templates
Pomodoro Timer for productivity
Customizable fonts and sizes
Metadata editing (title, description, tags)
Autosave and change tracking
Responsive design for desktop and mobile
Comprehensive keyboard shortcuts

Privacy & Security

At Hermes Markdown, we believe your privacy is fundamental. This section explains how we handle your data and what you can expect regarding security.

Data Storage & Privacy

Local-Only Storage: All your content is stored locally in your browser's local storage. Your documents never leave your device or get uploaded to any servers.
No Server Storage: We don't have any backend servers that store your data. Hermes Markdown is a client-side only application.
No Data Collection: We don't collect any personal information, usage statistics, or content from your documents.
No Analytics: We don't use tracking, analytics, or any data collection methods.
No Cookies: We don't use cookies for tracking or storing personal information.

Browser Permissions & Warnings

You may see browser warnings about site permissions. This is normal and expected for web applications that need to:

Access Local Storage: To save your work locally in your browser
Access File System: To import existing files and export your work
Send Notifications: For timer alerts (only if you enable them)

These permissions are only for local functionality - your content never leaves your device.

Data Management

Export Your Data: You can export your documents as markdown or PDF files to keep permanent copies on your device.
Clear Browser Data: You can clear your browser's local storage anytime, which will delete your saved documents.
Backup Strategy: We recommend regularly exporting important documents to ensure you have permanent copies.

Offline Functionality

Works Offline: Once loaded, Hermes Markdown works completely offline. You can write, edit, and export documents without an internet connection.
No Internet Required: After the initial page load, no internet connection is needed for any functionality.

Open Source Transparency

Open Source: Hermes Markdown is open source, meaning you can inspect the code to verify our privacy claims.
Code Review: The source code is available on GitHub, so you can see exactly how your data is handled.
Community Verification: The open source nature allows the community to review and verify our privacy practices.

Security Best Practices

HTTPS Only: The website uses HTTPS encryption to protect data in transit.
No Sensitive Data Transmission: Since all data stays local, there's no risk of data interception during transmission.
Browser Security: Your data is protected by your browser's built-in security features.

What We Don't Do

We don't track your writing or reading habits
We don't analyze your content
We don't share your data with third parties
We don't use your data for advertising
We don't store your documents on our servers
We don't require any account creation or personal information

Your Control

You have complete control over your data:

Export your documents anytime
Clear your browser data to remove all saved content
Use incognito/private browsing for additional privacy
Inspect the source code to verify our claims

Your privacy is our priority. We've designed Hermes Markdown to be as private as possible while still providing powerful markdown editing capabilities.

Markdown Syntax Guide (Quick Reference)

Headers: # H1, ## H2, ### H3
Bold: **bold**, Italic: *italic*, Strikethrough: ~~strike~~
Lists: - item, 1. item
Links: [text](url)
Images: ![alt](url)
Code: `inline`, ~~~block~~~
Tables: | h1 | h2 |

Tip: When you select a link in the editor, a popup appears allowing you to click and open the link directly.

For more details, see the full Markdown documentation online: Markdown Guide.