Skip to content

saiemsaeed/yazmak

Repository files navigation

Yazmak

License: MIT

A minimalist web-based text editor built with React, featuring Vim keybindings.

Overview

Yazmak is a modern, lightweight text editor designed for simplicity and ease of use. Built as a single-page application using React, Yazmak provides a clean interface for distraction-free writing and coding.

Features

  • 🚀 Modern, responsive web interface
  • ⌨️ Vim keybindings for efficient text editing
  • 📱 Works in any modern web browser
  • 🎨 Minimalist design philosophy
  • ⚡ Fast and lightweight performance

Yazmak

A minimalist web-based text editor built with React, featuring Vim keybindings.

Installation

npm install yazmak
# or
yarn add yazmak

Contribution

# Clone the repository
git clone https://github.com/saiemsaeed/yazmak.git

# Navigate to the project directory
cd yazmak

# Install dependencies
yarn install

# Start the development server
yarn dev

Usage

import { CustomEditor } from "yazmak";
import "yazmak/style.css"; // Important: import the styles

function App() {
  return (
    <CustomEditor
      initialText="# Hello World"
      lineRenderer={(line) => line}
      config={{ showLineNumbers: true }}
    />
  );
}

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published