Docs

About

Hyde is an open-source markdown editor, which utilizes the Electron framework to create a comfortable, cross-platform experience for every type of user.
Modularity is at the core of Hyde's interface design, allowing you to cater the UI to what you need. Whether you are a power-user that prefers keyboard shortcuts and a minimalistic interface, a visually-oriented user that prefers the accesibilty of toolbars and menus, or maybe somewhere in between, Hyde is capable of providing you with exactly what you need.

Install

Though there isn't an installer yet, using Hyde is simple. To use Hyde on any platform, you must first install npm and download Hyde from the project repo. Then simply run the following command from within the project directory:

# Clone the repository
$ git clone https://github.com/tterb/hyde

# Navigate to the directory
$ cd hyde

# Install Hyde
$ npm install -g ./

Now, Hyde can easily be launched from anywhere using the following command:

$ hyde <filename>

Usage

Command-line Interface

Hyde also features a convenient CLI, with support for a handful of helpful features.

$ hyde [options] <filename>

Note: If you'd like to utilize the compiled application, until a published release is available, you must build the app yourself. This can be done using the following command:

$ gulp build

Keyboard Shortcuts

Changelog

Contributing

If you're looking for an easy way to contribute to this project but aren't sure where to start, I've created a list of minor bugs and/or issues to be fixed before the projects initial release, which you can find here or you can just try out the app and provide some feedback.
Also, before submitting a pull-request, I would ask that you first take a look at the projects Contributing guidelines.