Skip to content

docs(readme): refine storage highlights #232

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ThisIs-Developer merged 1 commit into from
Jul 29, 2026
Merged

docs(readme): refine storage highlights #232

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 2 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,8 @@ Turn a document into a Share Snapshot link for quick handoffs, or start access-c

## Highlights

- **Workspace and documents:** organize as many documents as available device storage permits in nested folders; use Recent, Favorites, search, tabs, bulk actions, and an encrypted Secret Workspace.
- **Workspace and documents:** organize documents in nested folders with per-document IndexedDB storage on the web; use Recent, Favorites, search, tabs, bulk actions, and an encrypted Secret Workspace.
- **Backup and restore:** export or import complete workspace ZIPs while preserving folders and optional encrypted Secret Workspace files.
- **Editing and review:** switch among Editor, Split view, and Preview; use formatting tools, custom undo/redo, Find and Replace, LTR/RTL direction, comments, and suggestions.
- **Markdown rendering:** use CommonMark-style Markdown, GitHub-Flavored Markdown (GFM), tables, task lists, alerts, footnotes, definition lists, syntax highlighting, sanitized HTML, and MathJax.
- **Visual content:** render Mermaid, PlantUML, Graphviz/DOT, D2, Vega-Lite, WaveDrom, Markmap, GeoJSON, TopoJSON, STL, and ABC notation.
Expand Down Expand Up @@ -152,10 +153,6 @@ Remote renderer services receive the source of the diagram they render. Do not s

## Important Limits

- Markdown Viewer does not impose a document-count limit. The practical limit is available browser or filesystem storage.
- Browser documents use per-document IndexedDB records and load content on demand. Browser storage is best-effort by default; **Storage and Backup** reports usage and status, exports a complete ZIP backup, or restores one.
- Desktop workspace documents live as ordinary `.md` files under the fixed `Documents/Markdown Viewer Vault` path. App upgrades and executable replacement do not remove that vault.
- Workspace backup ZIPs preserve folders and can include Secret Workspace ciphertext. Secure files remain encrypted and require the original access key after import.
- A local Markdown file larger than 10 MB is rejected.
- The public GitHub importer shows at most 30 Markdown files for a repository or folder result.
- Managed source media is limited to 25 MiB before processing; stored payload limits are 300 KiB for still images, 5 MiB for GIFs, and 10 MiB for videos.
Expand Down
Loading