<commit_before><h1 align="center">
	<img src="./build/icons/256x256.png" width="128">
	<br>
	Sparks
</h1>
<p align="center" style="font-style: italic;">Minimal / Fast / Open-Source</p>

### Install

Sparks is still under development, . You can get the latest release [here](https://github.com/sjliang/sparks).

### Features

- Live preview
- Markdown syntax highlighting
- Light/Dark theme
- Emojis support :fire:
- Task lists support
- Foot notes support

### Todos

- [x] Fix image's width in preview area.
- [x] Add screenshots to README.
- [x] Configure `WordCounter` to only count alphanumeric words.
- [ ] Add Wiki.

### Tech Stack

- [Electron](http://electron.atom.io/) - Build cross platform desktop apps with JavaScript, HTML, and CSS.
- [React](https://facebook.github.io/react/) - JavaScript library for building interfaces.
- [Redux](http://redux.js.org/) - Predictable state container for JavaScript apps.
- [CodeMirror](https://codemirror.net/) - Versatile text editor implemented in JavaScript for the browser.

### Inspiration

Sparks is inspired by [Caret](https://caret.io/), [Moeditor](http://moeditor.org/) and [iA Writer](https://ia.net/writer). This app is in no competition with these listed apps.

Sparks was built mainly for the author to learn the tech stack mentioned above. It also does not have as many advanced features as the listed apps. If you like this app, the author highly recommends you to try out and use the mentioned apps above.

### Contribution Guidelines

Sparks is an open-source app, you can contribute to the app by [reporting issues](https://github.com/sjliang/sparks/issues) or [forking the repo and making pull requests](https://github.com/sjliang/sparks/pulls) on GitHub. If you would like any new feature to be implemented, please post the request on [the Issues page](https://github.com/sjliang/sparks/issues).

**Build**

> To build the app, you must have `NodeJS` and `npm` installed<commit_msg>Add shortcuts<commit_after><h1 align="center">
	<img src="./build/icons/256x256.png" width="128">
	<br>
	Sparks
</h1>
<p align="center" style="font-style: italic;">Minimal / Fast / Open-Source</p>

### Install

Sparks is still under development. You can get the latest release [here](https://github.com/sjliang/sparks).

### Features

- Live preview
- Markdown syntax highlighting
- Light/Dark theme
- Emojis support :fire:
- Task lists support
- Foot notes support

### Usage

- Shortcuts:
  - `Command (Ctrl) + N`: Create a new file
  - `Command (Ctrl) + O`: Open a file
  - `Command (Ctrl) + S`: Save a file
  - `Command (Ctrl) + Shift + S`: Save a file as...
  - `Command (Ctrl) + P`: Toggle half preview
  - `Command (Ctrl) + Shift + P`: Toggle full preview


### Todos

- [x] Fix image's width in preview area.
- [x] Add screenshots to README.
- [x] Configure `WordCounter` to only count alphanumeric words.
- [ ] Add Wiki.
- [ ] Add PDF export support.

### Tech Stack

- [Electron](http://electron.atom.io/) - Build cross platform desktop apps with JavaScript, HTML, and CSS.
- [React](https://facebook.github.io/react/) - JavaScript library for building interfaces.
- [Redux](http://redux.js.org/) - Predictable state container for JavaScript apps.
- [CodeMirror](https://codemirror.net/) - Versatile text editor implemented in JavaScript for the browser.

### Inspiration

Sparks is inspired by [Caret](https://caret.io/), [Moeditor](http://moeditor.org/) and [iA Writer](https://ia.net/writer). This app is in no competition with these listed apps.

Sparks was built mainly for the author to learn the tech stack mentioned above. It also does not have as many advanced features as the listed apps. If you like this app, the author highly recommends you to try out and use the mentioned apps above.

### Contribution Guidelines

Sparks is an open-source app, you can contribute to the app by [reporting issues](https://github.com/sjliang/sparks/issues) or [forking the repo and making pull requests](https://github.com/sjliang/sparks/pulls) on GitHub. If you would like any new feature to be implemented, please post the request on [the Issues page](https://github.com/sjliang/sparks/issues).

**Build**

> To build the app, you must have `NodeJS` and `npm` installed
{'fraction_non_alphanumeric': 0.12559129612109746, 'fraction_numerical': 0.005203405865657522, 'mean_word_length': 4.016607354685647, 'pattern_counts': {'":': 0, '<': 15, '<?xml version=': 0, '>': 17, 'https://': 16, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5638550', 'n_tokens_mistral': 1306, 'n_tokens_neox': 1261, 'n_words': 496}