Skip to content
📝 An Electron powered markdown editor for Jekyll users
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
assets
bin
docs
js
.codeclimate.yml
.eslintrc.yml
.gitattributes
.gitignore
.sass-lint.yml
.travis.yml
LICENSE
README.md
config.js
gulpfile.js
index.html
main.js
package.json
tray.js

README.md

Title


Build Status  Code Climate  Dependency Status  Version  License 

Description

Hyde is an Electron-based markdown editor that aims to improve the accessibility of creating beautifully formatted markdown documents for developers and non-developers, alike. This goal is achieved through an approachable modular interface, capable of offering the same familiar toolbars and live-preview that you would find in a word-processor or the simplicity and streamlined workflow of a minimalistic text editor. Additionally, while Hyde was initially created to cater to Jekyll users, during development the oppurtunity was recognized to similarly improve the writing experience across various platforms. Therefore, additional features have been integrated that allow Hyde to cater to the wide variety of popular platforms and tools that utilize markdown formatting.



Features

  • Live Preview
    • Instantly observe changes to your documents in rendered Markdown or HTML as you create them
    • YAML frontmatter recongition ensures that only your intended content is rendered
  • Sync-scrolling allows the preview to keep up with you as you type
  • GitHub Flavored Markdown (GFM)
  • User-friendly formatting via the toolbar
  • Syntax highlighting for Markdown, GFM-compatible HTML, and YAML frontmatter
  • A collection of 20+ popular syntax-themes
  • 🎉 Font Awesome, Glyphicon, and Emoji support 🎉
  • Full screen mode
    • Write free of all distractions
  • Support for TeX math rendering
  • Integrated spell-checking and word count
  • App can remain active in tray for quick access
  • All contained within an approachable, modular interface that caters to your workflow
  • Cross platform
    • Windows, Mac and Linux ready


Installation

Cloning, installing, and running Hyde is as simple as executing the following commands:

# 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>


Development

Preprocessor compilation and live-reload functionalities are available via the following command:

$ gulp watch


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. Additionally, if you'd like to submit a pull-request, I would ask that you first take a look at the projects contributing guidelines.



Proudly powered by:

Electron logo

You can’t perform that action at this time.