Skip to content

Lunatic16/NovaMarkdown

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 
 
 

Repository files navigation

NovaMarkdown - Advanced Notes Application

NovaMarkdown is a feature-rich, local-first Markdown notes application built with HTML5, CSS3, and Vanilla JavaScript. It provides a seamless writing experience with real-time preview, robust organization features, and flexible export options.

Features

  • Real-time Split-Screen Editor: Edit your Markdown on one side and see an instant, live preview on the other.
  • Rich Markdown Support: Full GitHub Flavored Markdown (GFM) including tables, task lists, and code blocks.
  • Syntax Highlighting: Beautiful and accurate syntax highlighting for code blocks using Prism.js.
  • Mathematical Typesetting: Render complex LaTeX equations directly in your notes with KaTeX (e.g., $$E = mc^2$$).
  • Hierarchical Organization: Organize your notes into nested folders, assign tags, and mark important notes as favorites.
  • Intelligent Tagging: Automatically extracts tags (e.g., #work, #personal) from your content and provides a clickable tag cloud for quick filtering.
  • Powerful Search: Instantly search across all your note titles and content.
  • Multi-Format Export: Export your notes to PDF, HTML, or raw Markdown formats.
  • Theme Customization: Toggle between Light and Dark modes, with dynamic updates to code syntax highlighting themes.
  • Customizable Settings: Personalize your experience with options for auto-save, line numbers, word count, and editor font size.
  • Note Deletion: Easily remove unwanted notes with a confirmation dialog to prevent accidental deletions.
  • Local-First & Secure: All your data is stored securely in your browser's localStorage, with easy backup (export) and restore (import) functionality.
  • Productivity Enhancements: Includes essential keyboard shortcuts (e.g., Ctrl+S for save, Ctrl+N for new note, Ctrl+B for bold, Ctrl+I for italic) and automatic saving with version history.
  • Responsive Design: Adapts to different screen sizes with collapsible panels for optimal viewing on any device.

Technologies Used

  • HTML5, CSS3 (with CSS Variables), Vanilla JavaScript (ES6+)
  • marked.js: For high-performance Markdown parsing.
  • Prism.js: For syntax highlighting in code blocks.
  • KaTeX: For fast and high-quality mathematical typesetting.
  • html2pdf.js: For client-side PDF generation from HTML content.

Getting Started

To use NovaMarkdown, simply open the index.html file in your web browser.

  1. Clone or Download: Get the project files to your local machine.
  2. Open index.html: Navigate to the NovaMarkdown directory and open index.html with your preferred web browser (Chrome, Firefox, Edge, Safari, etc.).

NovaMarkdown will load immediately, and you can start creating notes.

Usage

  • Creating a Note: Click the + icon in the sidebar or use Ctrl+N (or Cmd+N on macOS) to create a new note.
  • Editing: Type your Markdown content in the left pane. The right pane will update in real-time.
  • Saving: Notes are auto-saved. You can also manually save with Ctrl+S (or Cmd+S).
  • Folders, Tags, Favorites: Organize your notes using the sidebar panels. Click on folder names to expand/collapse them.
  • Searching: Use the search bar in the sidebar to find notes by title or content.
  • Exporting: Click the export icon (<i class="fas fa-file-export"></i>) in the editor header to export the current note.
  • Deleting Notes: Click the delete icon (<i class="fas fa-trash-alt"></i>) in the editor header to remove the current note (with confirmation).
  • Settings: Customize your experience using the settings icon (<i class="fas fa-cog"></i>) in the sidebar footer to adjust options like line numbers, word count, and editor font size.
  • Backup/Restore: Use the download (<i class="fas fa-download"></i>) and upload (<i class="fas fa-upload"></i>) icons in the sidebar footer to backup all your notes to a JSON file or restore them.
  • Dark/Light Mode: Toggle the theme using the moon/sun icon (<i class="fas fa-moon"></i> / <i class="fas fa-sun"></i>) in the sidebar footer.

Keyboard Shortcuts

  • Ctrl+N (or Cmd+N): Create a new note.
  • Ctrl+S (or Cmd+S): Manually save the current note.
  • Ctrl+B (or Cmd+B): Apply bold formatting to selected text.
  • Ctrl+I (or Cmd+I): Apply italic formatting to selected text.

Enjoy NovaMarkdown!# NovaMarkdown

About

NovaMarkdown is a feature-rich, local-first Markdown notes application built with HTML5, CSS3, and Vanilla JavaScript. It provides a seamless writing experience with real-time preview, robust organization features, and flexible export options.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors