Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/tterb/hyde
:pencil: An Electron powered markdown editor for Jekyll users
https://github.com/tterb/hyde
blog documentation editor electron gfm hyde jekyll markdown yaml-frontmatter
Last synced: 16 days ago
JSON representation
:pencil: An Electron powered markdown editor for Jekyll users
- Host: GitHub
- URL: https://github.com/tterb/hyde
- Owner: tterb
- License: gpl-3.0
- Created: 2017-06-20T05:10:38.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-07-20T17:21:44.000Z (over 4 years ago)
- Last Synced: 2024-10-12T05:08:39.244Z (about 1 month ago)
- Topics: blog, documentation, editor, electron, gfm, hyde, jekyll, markdown, yaml-frontmatter
- Language: CSS
- Homepage: https://brettstevenson.io/hyde
- Size: 12.8 MB
- Stars: 45
- Watchers: 5
- Forks: 11
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: docs/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: docs/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Description
**Hyde** is an [Electron](http://electron.atom.io)-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](https://jekyllrb.com) 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](https://github.github.com/gfm/))
* User-friendly formatting via the toolbar
* Syntax highlighting for Markdown, GFM-compatible HTML, and YAML frontmatter
* A collection of 20+ popular syntax-themes
* :tada: [Font Awesome](http://fontawesome.io), [Glyphicon](http://glyphicons.com/), and [Emoji](https://www.webpagefx.com/tools/emoji-cheat-sheet/) support :tada:
* Full screen mode
- Write free of all distractions
* Support for [TeX](https://www.latex-project.org/) 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:
```sh
# 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:
```sh
$ hyde
```
-------------------
# Development
Preprocessor compilation and live-reload functionalities are available via the following command:
```sh
$ 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](../../issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20is%3Ahelpwanted) or you can just try out the app and [provide some feedback](../../issues/new).
Additionally, if you'd like to submit a pull-request, I would ask that you first take a look at the projects [contributing guidelines](/docs/CONTRIBUTING.md).
Proudly powered by:
[
](http://electron.atom.io/)