{"id":36938638,"url":"https://github.com/omnicorest/omnicore-markdown-viewer","last_synced_at":"2026-02-18T22:00:50.841Z","repository":{"id":326410971,"uuid":"1105382482","full_name":"OmniCoreST/omnicore-markdown-viewer","owner":"OmniCoreST","description":"A sleek, cross-platform markdown viewer with full HTML support and Mermaid diagram rendering. Pop out mermaid charts and tables for better viewing and exporting.","archived":false,"fork":false,"pushed_at":"2026-02-16T21:16:41.000Z","size":5691,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-02-16T21:49:47.644Z","etag":null,"topics":["markdown-editor","markdown-pdf","markdown-pdf-export","mermaid","mermaid-preview"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/OmniCoreST.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-11-27T14:25:46.000Z","updated_at":"2026-02-14T08:54:46.000Z","dependencies_parsed_at":"2026-02-14T10:02:54.489Z","dependency_job_id":null,"html_url":"https://github.com/OmniCoreST/omnicore-markdown-viewer","commit_stats":null,"previous_names":["omnicorest/omnicore-markdown-viewer"],"tags_count":17,"template":false,"template_full_name":null,"purl":"pkg:github/OmniCoreST/omnicore-markdown-viewer","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OmniCoreST%2Fomnicore-markdown-viewer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OmniCoreST%2Fomnicore-markdown-viewer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OmniCoreST%2Fomnicore-markdown-viewer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OmniCoreST%2Fomnicore-markdown-viewer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/OmniCoreST","download_url":"https://codeload.github.com/OmniCoreST/omnicore-markdown-viewer/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/OmniCoreST%2Fomnicore-markdown-viewer/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29596328,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-18T20:59:56.587Z","status":"ssl_error","status_checked_at":"2026-02-18T20:58:41.434Z","response_time":162,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["markdown-editor","markdown-pdf","markdown-pdf-export","mermaid","mermaid-preview"],"created_at":"2026-01-13T10:20:39.134Z","updated_at":"2026-02-18T22:00:50.835Z","avatar_url":"https://github.com/OmniCoreST.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Omnicore Markdown Viewer\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"logo.png\" alt=\"Omnicore Logo\" height=\"100\"\u003e\n  \u003cp\u003e\u003cstrong\u003eA sleek, cross-platform markdown viewer with full HTML support, Mermaid diagram rendering, and powerful note-taking\u003c/strong\u003e\u003c/p\u003e\n\u003c/div\u003e\n\n![Platform](https://img.shields.io/badge/platform-Windows%20%7C%20macOS%20%7C%20Linux-blue)\n![License](https://img.shields.io/badge/license-MIT-green)\n![Electron](https://img.shields.io/badge/Electron-27.0-blue)\n\n## What's New in v1.9.0\n\n- **Robust Note Styling** - Notes now display with colored background highlight and colored underline, applied reliably regardless of sanitization\n- **Complete Note Hiding** - Hidden notes are fully invisible: no background, no underline, no tooltip on hover/click, text appears completely normal\n- **File/View/Tools Dropdown Menus** - Organized menu bar with File, View, and Tools dropdowns\n- **All Notes Panel** - Side panel listing all notes with search and navigation\n- **Inline Text Editing** - Right-click selected text to edit in place with partial DOM rendering\n- **Partial Rendering** - Edits re-render only affected sections, no full page refresh\n\n## Features\n\n### Core Rendering\n- **Full HTML Support** - Render HTML tags within markdown with DOMPurify sanitization\n- **Mermaid Diagrams** - Beautiful diagram rendering with interactive popup viewer featuring pan/zoom controls\n- **OmniWare Wireframes** - Built-in wireframe diagram support\n- **PrismJS Syntax Highlighting** - Code blocks with Solarized Light theme (offline support for 11+ languages)\n- **Interactive Tables** - Tabulator.js integration with sorting, filtering, pagination, and CSV/JSON export\n\n### Editing \u0026 Export\n- **Live Markdown Editor** - Split-view editing with 3-second debounced preview and Fira Code font\n- **Inline Text Editing** - Right-click any selected text to edit it in place with partial rendering (no full page refresh)\n- **PDF Export** - One-click export with full styling, diagrams, and syntax highlighting\n- **Word Export** - Export documents as Microsoft Word (.docx) files\n- **Auto-Save Detection** - Unsaved changes indicator with confirmation prompts\n\n### Note System\n- **Text Notes** - Select any text and add colored notes with background highlight and colored underline\n- **Image Notes** - Annotate images with notes\n- **Note Labels** - Place floating label badges anywhere in the document\n- **All Notes Panel** - Side panel listing all notes sorted by ID with search functionality\n- **Note Search** - Search notes by ID or title, with auto-scroll to matching note\n- **Find Note** - Quick note lookup via right-click context menu\n- **Show/Hide Notes** - Toggle note visibility; when hidden, notes are completely invisible (no background, no underline, no tooltip on hover)\n- **Edit \u0026 Delete Notes** - Right-click context menu on notes for editing and deletion\n- **6 Color Options** - Orange, red, green, blue, purple, yellow\n\n### Navigation \u0026 UI\n- **Dropdown Menus** - Organized File, View, and Tools dropdown menus\n  - **File** - Open, Table of Contents, Edit Mode, All Notes, Export (PDF/Word), Recent Files\n  - **View** - Zoom, Dark Mode, Fullscreen, Show/Hide Notes\n  - **Tools** - Language settings (Document translation \u0026 Interface language)\n- **Auto Table of Contents** - Hierarchical index of all headers (H1-H6) with one-click navigation\n- **Search with Highlighting** - Real-time text search with match counter and keyboard navigation (Ctrl+F)\n- **File Path Display** - Shows current file path with copy-to-clipboard functionality\n\n### View Controls\n- **Dark Mode** - Toggle between light and dark themes\n- **Zoom Controls** - Flexible zoom from 50% to 200% via keyboard shortcuts or mouse wheel\n- **Fullscreen Mode** - Distraction-free viewing (F11)\n\n### Translation \u0026 Localization\n- **Document Translation** - Translate documents to English or Turkish via Google Translate\n- **Interface Language** - Switch UI language between English and Turkish\n- **Dual-source Editing** - Edit documents while viewing translations without switching back\n\n### Right-Click Context Menu\n- **Copy / Copy as Plain Text**\n- **Edit Text** - Edit selected text inline with partial DOM rendering\n- **Bold / Italic / Code Block / List** - Quick formatting\n- **Remove Formatting** - Strip markdown formatting from selection\n- **Add Note / Edit Note / Delete Note / Find Note** - Full note management\n- **Insert Image / Delete Image**\n- **Select All**\n\n### Additional Features\n- **Professional Theme** - Clean interface with Omnicore branding (#279EA7 teal, #1F3244 navy)\n- **Cross-Platform** - Works on Windows, macOS, and Linux\n- **Offline Support** - All libraries bundled locally, no internet required\n- **Single Instance** - Prevents multiple app instances\n- **Toast Notifications** - User-friendly feedback for all operations\n- **Recent Files** - Quick access to last 100 files from File menu\n\n## Installation\n\n### Download Pre-built Releases\n\nDownload the latest release from the [Releases page](https://github.com/OmniCoreST/omnicore-markdown-viewer/releases):\n\n| Platform | File | Description |\n|----------|------|-------------|\n| Windows | `Omnicore-Markdown-Viewer-Setup-X.X.X.exe` | Windows installer |\n| Linux | `Omnicore.Markdown.Viewer-X.X.X.AppImage` | Portable AppImage |\n| Linux | `omnicore-markdown-viewer_X.X.X_amd64.deb` | Debian/Ubuntu package |\n\n### Windows Installation Note\n\n\u003e **\"Windows protected your PC\" Warning**\n\u003e\n\u003e On first run, Windows SmartScreen may show a warning because the app is not code-signed.\n\u003e\n\u003e **To proceed:**\n\u003e 1. Click **\"More info\"**\n\u003e 2. Click **\"Run anyway\"**\n\u003e\n\u003e This is safe - you can verify the source code in this repository.\n\n### Build from Source\n\n1. Install dependencies:\n```bash\nnpm install\n```\n\n## Running the Application\n\nStart the application in development mode:\n```bash\nnpm start\n```\n\n## Building for Production\n\n### Standalone Portable EXE (No Installation Required)\n```bash\nnpm run build\n```\nThis creates a portable `.exe` file in `dist/` folder that can run without installation.\n\n### Windows Installer (NSIS)\n```bash\nnpm run build-installer\n```\nThis creates a Windows installer in `dist/` folder.\n\n### Build Both\n```bash\nnpm run build-all\n```\nThis creates both portable exe and installer.\n\n**Output location:** `dist/` folder\n\n## Controls\n\n### Keyboard Shortcuts\n\n- **Ctrl+O** (Cmd+O on Mac) - Open markdown file\n- **Ctrl+S** (Cmd+S on Mac) - Save file (in edit mode)\n- **Ctrl+F** (Cmd+F on Mac) - Open search panel\n- **Ctrl+B** - Bold selected text\n- **Ctrl+I** - Italic selected text\n- **Ctrl+`** - Code block\n- **Enter** (in search) - Next match\n- **Shift+Enter** (in search) - Previous match\n- **Escape** - Close search panel / Exit dialogs\n- **Ctrl++** - Zoom in\n- **Ctrl+-** - Zoom out\n- **Ctrl+0** - Reset zoom to 100%\n- **Ctrl+Enter** - Save in Edit Text dialog\n- **F11** - Toggle fullscreen\n\n### Mouse Controls\n\n- **Ctrl+Mouse Wheel** (Cmd+Mouse Wheel on Mac) - Zoom in/out\n  - Scroll up to zoom in\n  - Scroll down to zoom out\n- **Right-click** - Context menu with formatting, notes, and editing options\n\n### Search Features\n\n- **Real-time highlighting** - Matches are highlighted as you type\n- **Match counter** - Shows current match and total matches (e.g., \"3 of 15\")\n- **Navigation** - Use arrow buttons or Enter/Shift+Enter to navigate\n- **Case-insensitive** - Searches ignore case differences\n- **Minimum 2 characters** - Search activates after typing at least 2 characters\n\n### Table of Contents\n\n- **Auto-generated** - Automatically extracts all headers (H1-H6) from document\n- **Hierarchical display** - Shows header levels with indentation\n- **One-click navigation** - Click any header to jump to that section\n- **Active highlighting** - Current section is highlighted in the TOC\n- **Accessible from File menu** - Toggle via File \u003e Table of Contents\n\n## Supported File Types\n\n- `.md` - Markdown\n- `.markdown` - Markdown\n- `.mdown` - Markdown\n- `.mkd` - Markdown\n- `.mkdn` - Markdown\n\n## Opening Files\n\n### Method 1: Within the App\n- Press `Ctrl+O` or use File \u003e Open File\n- Access recent files from File \u003e History section\n\n### Method 2: Windows \"Open With\"\n- Right-click any `.md` file in Windows Explorer\n- Select \"Open with\" \u003e \"Omnicore Markdown Viewer\"\n- The file opens directly in the app\n\n### Method 3: Default Program (After Installer)\n- The NSIS installer registers the app for `.md` files\n- You can set it as the default program for markdown files\n- Double-click any `.md` file to open in Omnicore Markdown Viewer\n\n## Mermaid Support\n\nThe viewer supports all Mermaid diagram types. Simply use mermaid code blocks:\n\n\\`\\`\\`mermaid\ngraph TD\n    A[Start] --\u003e B[Process]\n    B --\u003e C[End]\n\\`\\`\\`\n\n## Technology Stack\n\n- **Electron 27.0** - Cross-platform desktop framework\n- **Marked** - Fast markdown parser with full GFM support\n- **Mermaid** - Diagram rendering engine (flowcharts, sequence diagrams, etc.)\n- **Tabulator.js 6.2.5** - Interactive table library with advanced features\n- **PrismJS** - Syntax highlighting for code blocks (11+ languages)\n- **DOMPurify** - XSS protection via HTML sanitization\n- **Fira Code** - Beautiful monospace font for code editing\n\n## Screenshots\n\n### Main Interface with Table of Contents\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"ss/markdown-viewer_1.png\" alt=\"Omnicore Markdown Viewer - Main Interface\" width=\"800\"\u003e\n  \u003cp\u003e\u003cem\u003eClean interface showing markdown rendering with Table of Contents sidebar\u003c/em\u003e\u003c/p\u003e\n\u003c/div\u003e\n\n### File Path Display and Toolbar\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"ss/markdown-viewer_2.png\" alt=\"Markdown Viewer - Toolbar\" width=\"800\"\u003e\n  \u003cp\u003e\u003cem\u003eToolbar with File, View, and Tools dropdown menus\u003c/em\u003e\u003c/p\u003e\n\u003c/div\u003e\n\n### Recent Files Manager\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"ss/markdown-viewer_recent_files.png\" alt=\"Recent Files Panel\" width=\"400\"\u003e\n  \u003cp\u003e\u003cem\u003eQuick access to recently opened files from File menu\u003c/em\u003e\u003c/p\u003e\n\u003c/div\u003e\n\n### Hierarchical Table of Contents\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"ss/markdown-viewer_recent_toc.png\" alt=\"Table of Contents\" width=\"800\"\u003e\n  \u003cp\u003e\u003cem\u003eAuto-generated TOC showing all document headers with hierarchical indentation\u003c/em\u003e\u003c/p\u003e\n\u003c/div\u003e\n\n### Mermaid Diagram Popup Viewer\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"ss/markdown-viewer_recent_mermaid_opened.png\" alt=\"Mermaid Popup Window\" width=\"800\"\u003e\n  \u003cp\u003e\u003cem\u003eInteractive Mermaid popup window with pan (click \u0026 drag) and zoom (scroll wheel) controls\u003c/em\u003e\u003c/p\u003e\n\u003c/div\u003e\n\n### Interactive Table Viewer (Tabulator.js)\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"ss/markdown-viewer_recent_table_popout.png\" alt=\"Interactive Table Popup\" width=\"800\"\u003e\n  \u003cp\u003e\u003cem\u003eAdvanced table viewer with column sorting, filtering, pagination, and CSV/JSON export\u003c/em\u003e\u003c/p\u003e\n\u003c/div\u003e\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n## Development\n\n```bash\n# Install dependencies\nnpm install\n\n# Run in development mode\nnpm start\n\n# Build for Windows\nnpm run build-all\n```\n\n## License\n\nMIT License - see the [LICENSE](LICENSE) file for details\n\n## Credits\n\nDeveloped by [Omnicore](https://www.omnicore.com.tr)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fomnicorest%2Fomnicore-markdown-viewer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fomnicorest%2Fomnicore-markdown-viewer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fomnicorest%2Fomnicore-markdown-viewer/lists"}