Skip to content
NorwinYuPublic

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Repository files navigation

NorMark

A professional Markdown reader and editor for Mac, crafted by Norwin Yu.

Features

  • ✅ Multiple Workspaces - Open and manage multiple folders
  • ✅ Live Preview - Real-time Markdown rendering
  • ✅ Code Support - Syntax highlighting for 30+ programming languages
  • ✅ Theme Switching - Light, Dark, and System modes
  • ✅ PDF Export - Clean, professional document export
  • ✅ View Modes - Edit, Preview, and Split view
  • ✅ Focus Mode - Distraction-free writing experience
  • ✅ Typewriter Mode - Keep your current line centered
  • ✅ Word Count - Real-time word, character, and line statistics
  • ✅ Favorites - Quick access to frequently used files
  • ✅ Recent Files - Track recently opened documents
  • ✅ Auto Save - Configurable automatic saving
  • ✅ macOS Native - Beautiful integration with macOS

Supported Languages

NorMark provides syntax highlighting for:

Category Languages
Web JavaScript, TypeScript, JSX, TSX, HTML, CSS, Vue
Backend Python, Java, Go, Rust, PHP, Ruby
Systems C, C++, Rust, Go
Data JSON, YAML, SQL, XML
Shell Bash, Zsh, Shell scripts
Other Markdown, and more...

Installation

Prerequisites

  • Node.js 18+
  • npm or yarn

Development

# Clone the repository
git clone https://github.com/norwinyu/normark.git
cd normark

# Install dependencies
npm install

# Start development mode
npm run dev

Build for Production

# Build the app
npm run build

# Package for macOS (creates DMG and ZIP)
npm run build:mac

The built app will be in the dist/ directory.

Usage

Opening Files and Folders

  1. Open a folder: Click the folder icon (📁) in the sidebar header or press Cmd+Shift+O
  2. Open a file: Press Cmd+O to open a single file
  3. Multiple workspaces: You can add multiple folders - they appear as collapsible sections in the sidebar

Navigating Files

  • Click on any file in the sidebar to open it
  • Use the search bar to filter files by name
  • Expand/collapse folders by clicking on them
  • Use the Files, Favorites, and Recent tabs to organize your view

Favorites

  • Click the star icon (⭐) next to any file to add it to favorites
  • Access favorites quickly from the Favorites tab
  • Starred files show a filled yellow star

View Modes

  • Edit Mode (Cmd+1): Full-screen editor
  • Preview Mode (Cmd+2): Full-screen rendered preview
  • Split Mode (Cmd+3): Side-by-side editor and preview

Editor Features

  • Focus Mode: Click the eye icon to dim non-active lines
  • Typewriter Mode: Click the "T" icon to keep your current line centered
  • Auto-save: Files are automatically saved after 1 second of inactivity

Exporting

  • Click PDF button in the header to export the current document
  • The PDF contains only the rendered content (no app UI)

Theme

  • Click the theme icon (☀️/🌙) to cycle through Light → Dark → System modes

Keyboard Shortcuts

Action Shortcut
Edit Mode Cmd + 1
Preview Mode Cmd + 2
Split Mode Cmd + 3
Save Cmd + S
Open File Cmd + O
Open Folder Cmd + Shift + O
Toggle Theme Cmd + Shift + T
Toggle Sidebar Cmd + \
Export PDF Cmd + Shift + P

Tech Stack

  • Electron - Cross-platform desktop apps
  • React 18 - UI framework
  • TypeScript - Type safety
  • CodeMirror 6 - Code editor with syntax highlighting
  • markdown-it - Markdown parser
  • highlight.js - Syntax highlighting for preview
  • Tailwind CSS - Styling
  • Zustand - State management

License

MIT License. All dependencies are open source (MIT, Apache-2.0, BSD-3-Clause, ISC).

Author

Norwin Yu


Made with ❤️ by Norwin Yu

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages