Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/suryarajendhran/markdown-editor

Last synced: about 12 hours ago
JSON representation

Host: GitHub
URL: https://github.com/suryarajendhran/markdown-editor
Owner: suryarajendhran
License: mit
Created: 2020-05-20T06:12:56.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2022-11-10T17:56:59.000Z (about 2 years ago)
Last Synced: 2025-01-22T16:50:32.176Z (1 day ago)
Language: JavaScript
Size: 113 KB
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 7
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

# Markdown editor

![GitHub top language](https://img.shields.io/github/languages/top/suryarajendhran/markdown-editor)
![GitHub commit activity](https://img.shields.io/github/commit-activity/m/suryarajendhran/markdown-editor)
![GitHub](https://img.shields.io/github/license/suryarajendhran/markdown-editor)

Markdown editor is a cross-platform desktop application built using [ElectronJS](https://www.electronjs.org/) for working with markdown files. It is currently in development.

## Installation

Clone this repository and use [yarn](https://classic.yarnpkg.com/en/docs/install) to install the dependencies.

```bash
git clone https://github.com/suryarajendhran/markdown-editor.git
cd markdown-editor
yarn
```

## Usage
Currently, the project only runs in development mode. Building and packaging will be implemented later.

```bash
yarn start
```

## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update the tests as appropriate.

## License
[MIT](https://choosealicense.com/licenses/mit/)