README.md

Notes

A simple and intuitive markdown-based note-taking application. Create, edit, and organize your notes with ease using markdown syntax.

Features

• Markdown Editing: Write notes in markdown, with real-time preview.
• Organize Notes: Easily create and switch between multiple notes.
• Auto-save: Notes are automatically saved to local storage.
• Responsive Design: Works seamlessly on desktops and tablets.
• Rich Toolbar: Access markdown editing tools (bold, italic, links, lists, etc.) right from the toolbar.

Tech Stack

• React with TypeScript
• @uiw/react-md-editor for markdown editing
• React Split for resizable panes
• Tailwind CSS for styling
• Local Storage for saving notes on the client-side

TL;DR

This template provides a minimal setup to get React working in Vite with HMR and some ESLint rules.

Currently, two official plugins are available:

• @vitejs/plugin-react uses Babel for Fast Refresh
• @vitejs/plugin-react-swc uses SWC for Fast Refresh

Expanding the ESLint configuration

If you are developing a production application, we recommend updating the configuration to enable type aware lint rules:

• Configure the top-level parserOptions property like this:

export default tseslint.config({
  languageOptions: {
    // other options...
    parserOptions: {
      project: ['./tsconfig.node.json', './tsconfig.app.json'],
      tsconfigRootDir: import.meta.dirname,
    },
  },
})

• Replace tseslint.configs.recommended to tseslint.configs.recommendedTypeChecked or tseslint.configs.strictTypeChecked
• Optionally add ...tseslint.configs.stylisticTypeChecked
• Install eslint-plugin-react and update the config:

// eslint.config.js
import react from 'eslint-plugin-react'

export default tseslint.config({
  // Set the react version
  settings: { react: { version: '18.3' } },
  plugins: {
    // Add the react plugin
    react,
  },
  rules: {
    // other rules...
    // Enable its recommended rules
    ...react.configs.recommended.rules,
    ...react.configs['jsx-runtime'].rules,
  },
})