Skip to content

An offline PWA support minimalist text editor supporting markdown preview and multiple file exports

Notifications You must be signed in to change notification settings

gourav221b/simple-text-editor

Repository files navigation

Simple Text Editor

About

This web-based text editor is a project inspired by Jimmy Breck-McKye's minimalistic approach, enhanced with additional features to provide a robust writing and editing experience.

Features

  • Local Storage: All your text is securely saved on your local machine, ensuring privacy and accessibility only to you.
  • Persistent Data: Data is stored locally and remains intact even if you reload the page.
  • Markdown Support: Enjoy markdown preview capabilities within the editor.
  • Offline Usage: Use the editor seamlessly without an internet connection.
  • Export Options: Export your content in various formats including .txt, .csv, and .md.
  • Shareable URLs: Generate tokenized URLs to share your content. Edits made by others won't affect your version.

Usage

  1. Writing: Start typing and editing text directly in the editor.
  2. Saving: Your work is automatically saved locally.
  3. Exporting: Choose your preferred format for exporting.
  4. Sharing: Share your work using the generated tokenized URL.

Getting Started

To run the project locally, follow these steps:

  1. Clone this repository: git clone https://github.com/gourav221b/simple-text-editor
  2. Install dependencies: npm install or yarn install
  3. Start the application: npm run dev or yarn dev
  4. Open your browser and navigate to http://localhost:3000 (or the appropriate port).

Contributing

Contributions are welcome! Please fork the repository and submit a pull request with your improvements.

Feedback

Have any feedback or suggestions? Feel free to reach out to me at your.email@example.com.

About

An offline PWA support minimalist text editor supporting markdown preview and multiple file exports

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published