Skip to content

TheSolutionDeskAndCompany/markdown-notes

📝 Markdown Notes

Live Demo License: MIT PRs Welcome GitHub issues GitHub stars


🚀 Live Demo

👉 Try it now!

📸 Screenshots

Light Mode

Markdown Notes - Light Mode

Dark Mode

Markdown Notes - Dark Mode

Mobile Responsive

Markdown Notes - Mobile


⚡ Quick Start

Use Online: Just visit the live demo — no install needed!

Run Locally:

git clone https://github.com/thesolutiondeskandcompany/markdown-notes.git
cd markdown-notes
npm install
npm run dev
# Visit http://localhost:5173

💡 Features

  • Live Markdown Preview as you type
  • Multiple Notes: create, edit, organize
  • Dark/Light Mode toggle
  • Keyboard Shortcuts: work faster
  • Export: save notes as Markdown files
  • Responsive: desktop & mobile ready
  • Local Storage: automatic save
  • Syntax Highlighting for code blocks

📚 What You Can Do

📝 Multiple Notes Management

• Create unlimited notes with custom titles
• Auto-save as you type (300ms debounce)
• Switch between notes instantly
• Delete notes you no longer need

⚡ Live Markdown Preview

# Meeting Notes - Project Alpha

## Action Items
- [x] Review design mockups
- [ ] Schedule client call
- [ ] Update project timeline

## Code Snippets
```javascript
const handleSubmit = async (data) => {
  const response = await api.post('/notes', data);
  return response.data;
};

🎨 Rich Formatting Support

  • Bold, italic, strikethrough text
  • Tables with proper styling
  • Blockquotes with custom borders
  • External links (open in new tabs)
  • Syntax-highlighted code blocks

🎨 Advanced Features

  • Real-time word & character count (shown in editor footer)
  • Search notes with live filtering (Ctrl+K to focus)
  • Customizable note titles (click to edit inline)
  • Auto-save with debounce (300ms delay)
  • Sidebar toggle for distraction-free writing
  • Split-view controls (toggle editor/preview panels)

⌨️ Keyboard Shortcuts

  • Ctrl+N — New note
  • Ctrl+S — Save note (auto-saves anyway)
  • Ctrl+D — Toggle dark/light mode
  • Ctrl+B — Toggle sidebar
  • Ctrl+P — Toggle preview
  • Ctrl+E — Toggle editor
  • Ctrl+K — Search notes

🛠️ Deployment

  • Already Deployed: GitHub Pages

  • Build & Deploy:

    npm run build
    npm run deploy

🤝 Contributing

We welcome PRs and ideas! See CONTRIBUTING.md.

Ways to contribute:

  • Report bugs / suggest features (issues)
  • Submit PRs to improve code or docs
  • Star ⭐ and share the repo!

🙏 Credits


📄 License

MIT


Made with ❤️ by The Solution Desk & Company

About

No description, website, or topics provided.

Resources

License

Code of conduct

Contributing

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published