YAME: Yet another Markdown Editor

YAME is a simple and lightweight Markdown editor built with React. It allows users to write and preview Markdown content in real-time.

Baptism of Code Ongoing, to remove the sins of the developer, future commits may contain breaking Changes.

Quickstart Guide on Making Extensions are now provided. Read MAKING_EXTENSIONS.md

Getting Started

To get started with Yame, open Yame in your browser. If you are using Chromium based Browsers you can install it straight from the browser, regardless of the OS/Platform you are on.

Features

• Supports Github, Notion, Dev.to and Medium markdown flavors
• Supports External Themes via External URL (though, the dev will need to read the Editor Source Code to understand how)
• Allows External Extensions to be added to the Editor (limited to dev console for now)
• Meth Math Support
• File Sharing Support ( Thanks @hect1k ) )
• Allows exporting to PDF and HTML
• Minimal and Lightweight (debatable, but atleast its lighter than ur mom)
• No Server-side dependencies (Really)
• Autosave
• Toggle Preview Mode using URL bar, just add ?preview=true to the URL
• Fetch Remote file with ?fetchFrom=theUrl
• File Open, Local and Remote
• PWA Support, so you can just Install the App from the Browser it self!

TODOS:

• MAIN FOCUS + Refinement Extensions Support to allow devs to make custom extensions and add them to the editor
• Refinement of Theme API
• Refinement of Exports to PDF and HTML to produce Consistent outputs
• Multi File Support to allow multiple tabs and allow Notebook like functionality like Obsidian Sometimes I think this is unnecessary
• Allow changing Code Block Themes
• Add more Markdown flavors
• Get a Nice Logo Important

Note for Theme Developers

• There is no official Documentation for the Theme Selector. If you want to make a custom theme, please refer to MAKING_THEMES.md for a quickstart and see public/space-cadet.css for a real-world example.
• If you think the existing theme API is not sufficient, please open an issue and provide details or a PR.
• Have a look at This Marketplace Repo which contains themes and extensions for

Contributing

View the CONTRIBUTING.md file for details on how to contribute to ths project.

Video Demo

Running

Clone Repo

To clone this Repo:

git clone https://github.com/NotoriousArnav/MarkdownEditor.git

Install Dependencies

To Install Dependencies run:

npm i

Changing the SWFT Instance

The Default SWFT Instance is https://share.nnisarg.in To change the SWFT Instance run:

export VITE_SWFT_INSTANCE="https://someinstance.com"
# or
echo "VITE_SWFT_INSTANCE='https://someinstance.com'" > .env

Development Server

To run the application, use the following command:

npm run dev

Build

Build for production

To build the application for production, use the following command:

npm run build

Build for development

To build the application for development, use the following command:

npm run build:dev