Skip to content

Commit

Permalink
📚 Update project documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
tterb committed Nov 28, 2017
1 parent 4400f96 commit 69ac386
Show file tree
Hide file tree
Showing 3 changed files with 78 additions and 72 deletions.
15 changes: 11 additions & 4 deletions docs/Credits.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,16 +8,23 @@ Thank you to all of the resources that inspired and/or contributed to the develo
- [**JQuery**](https://jquery.com/)
- [**Gulp**](https://gulpjs.com/)
- [**Showdown**](http://showdownjs.github.io/showdown/)
* [**Showdown-icon**](https://github.com/dbtek/showdown-icon)
* [**Showdown-highlight**](https://github.com/Bloggify/showdown-highlight)
- [**Showdown-icon**](https://github.com/dbtek/showdown-icon)
- [**Showdown-highlight**](https://github.com/Bloggify/showdown-highlight)
- [**CodeMirror**](http://codemirror.net/)
* [**CodeMirror-Spell-Checker**](https://github.com/sparksuite/codemirror-spell-checker)
- [**CodeMirror-Spell-Checker**](https://github.com/sparksuite/codemirror-spell-checker)
- [**Open Sans**](https://fonts.google.com/specimen/Open+Sans)
- [**Source Code Pro**](https://fonts.google.com/specimen/Source+Code+Pro)
- [**FontAwesome**](http://fontawesome.io)
- [**Glyphicons**](http://glyphicons.com)
- [**Emoji Cheat Sheet**](https://github.com/arvida/emoji-cheat-sheet.com)
- [**Markdownify**](https://github.com/amitmerchant1990/electron-markdownify)
- [**Parse Katex**](https://github.com/joshuacaron/parse-katex)
- [**Devtron**](https://www.npmjs.com/package/devtron)
- [**Yargs**](https://www.npmjs.com/package/yargs)
- [**Electron Localshortcut**](https://github.com/parro-it/electron-localshortcut)
- [**Electron JSON Storage**](https://github.com/electron-userland/electron-json-storage)
- [**Electron Connect**](https://github.com/Quramy/electron-connect)
- [**Markdownify**](https://github.com/amitmerchant1990/electron-markdownify)
- [**Electron Settings**](https://www.npmjs.com/package/electron-settings)
- [**Electron Window**](https://www.npmjs.com/package/electron-window)
- [**Electron Window State**](https://www.npmjs.com/package/electron-window-state)
- [**Electron Packager**](https://www.npmjs.com/package/electron-packager)
81 changes: 40 additions & 41 deletions docs/Keybindings.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,56 +2,55 @@

## Operations

| Command | Shortcut |
|:---------------------|:-------------------------------:|
| New File | <kbd>Ctrl + N</kbd> |
| Open File | <kbd>Ctrl + O</kbd> |
| Save File | <kbd>Ctrl + S</kbd> |
| Save As | <kbd>Ctrl + Shift + S</kbd> |
| Toggle Menu | <kbd>Ctrl + M</kbd> |
| Toggle Toolbar | <kbd>Ctrl + .</kbd> |
| Toggle Preview | <kbd>Ctrl + P</kbd> |
| Toggle Fullscreen| <kbd>F11</kbd> |
| Toggle Dev Tools | <kbd>Ctrl + Shift + I</kbd> |
| Toggle Settings | <kbd>Ctrl + ,</kbd> |
| Markdown Help | <kbd>Ctrl + Shift + ?</kbd> |
| Command | Win/Linux | macOS |
|:---------------------|:-------------------------------:|:-------------------------------:|
| New File | <kbd>Ctrl + N</kbd> | <kbd>Cmd + N</kbd> |
| Open File | <kbd>Ctrl + O</kbd> | <kbd>Cmd + O</kbd> |
| Save File | <kbd>Ctrl + S</kbd> | <kbd>Cmd + S</kbd> |
| Save As | <kbd>Ctrl + Shift + S</kbd> | <kbd>Cmd + Shift + S</kbd> |
| Toggle Menu | <kbd>Ctrl + M</kbd> | <kbd>Cmd + M</kbd> |
| Toggle Toolbar | <kbd>Ctrl + .</kbd> | <kbd>Cmd + .</kbd> |
| Toggle Preview | <kbd>Ctrl + P</kbd> | <kbd>Cmd + P</kbd> |
| Toggle Fullscreen| <kbd>F11</kbd> | <kbd>F11</kbd> |
| Toggle Dev Tools | <kbd>Ctrl + Shift + I</kbd> | <kbd>Cmd + Alt + I</kbd> |
| Toggle Settings | <kbd>Ctrl + ,</kbd> | <kbd>Cmd + ,</kbd> |
| Markdown Help | <kbd>Ctrl + Shift + ?</kbd> | <kbd>Cmd + Shift + ?</kbd> |

--------------------

## Editing

| Command | Shortcut |
|:---------------------|:-------------------------------:|
| Undo | <kbd>Ctrl + Z</kbd> |
| Redo | <kbd>Ctrl + Shift + Z</kbd> |
| Cut | <kbd>Ctrl + X</kbd> |
| Copy | <kbd>Ctrl + C</kbd> |
| Paste | <kbd>Ctrl + V</kbd> |
| Find | <kbd>Ctrl + F</kbd> |
| Replace | <kbd>Ctrl + Shift + F</kbd> |
| Indent Less | <kbd>Ctrl + left-arrow</kbd> |
| Indent More | <kbd>Ctrl + right-arrow</kbd> |
| Page Up | <kbd>Ctrl + up-arrow</kbd> |
| Page Down | <kbd>Ctrl + down-arrow</kbd> |

| Command | Win/Linux | macOS |
|:---------------------|:-------------------------------:|:-------------------------------:|
| Undo | <kbd>Ctrl + Z</kbd> | <kbd>Cmd + Z</kbd> |
| Redo | <kbd>Ctrl + Shift + Z</kbd> | <kbd>Cmd + Shift + Z</kbd> |
| Cut | <kbd>Ctrl + X</kbd> | <kbd>Cmd + X</kbd> |
| Copy | <kbd>Ctrl + C</kbd> | <kbd>Cmd + C</kbd> |
| Paste | <kbd>Ctrl + V</kbd> | <kbd>Cmd + V</kbd> |
| Find | <kbd>Ctrl + F</kbd> | <kbd>Cmd + F</kbd> |
| Replace | <kbd>Ctrl + Shift + F</kbd> | <kbd>Cmd + Shift + F</kbd> |
| Indent Less | <kbd>Ctrl + left-arrow</kbd> | <kbd>Cmd + left-arrow</kbd> |
| Indent More | <kbd>Ctrl + right-arrow</kbd> | <kbd>Cmd + right-arrow</kbd> |
| Page Up | <kbd>Ctrl + up-arrow</kbd> | <kbd>Cmd + up-arrow</kbd> |
| Page Down | <kbd>Ctrl + down-arrow</kbd> | <kbd>Cmd + down-arrow</kbd> |

--------------------

## Formatting

| Command | Shortcut |
|:---------------------|:-------------------------------:|
| Header | <kbd>Ctrl + H</kbd> |
| Bold | <kbd>Ctrl + B</kbd> |
| Italic | <kbd>Ctrl + I</kbd> |
| Strikethrough | <kbd>Ctrl + -</kbd> |
| Insert Link | <kbd>Ctrl + L</kbd> |
| Insert Image | <kbd>Ctrl + K</kbd> |
| Insert Emoji | <kbd>Ctrl + E</kbd> |
| Create Table | <kbd>Ctrl + T</kbd> |
| Toggle Code | <kbd>Ctrl + ;</kbd> |
| Toggle Comment | <kbd>Ctrl + /</kbd> |
| Toggle Blockquote| <kbd>Ctrl + '</kbd> |
| Horizontal Rule | <kbd>Ctrl + Shift + _</kbd> |
| Command | Win/Linux | macOS |
|:---------------------|:-------------------------------:|:-------------------------------:|
| Header | <kbd>Ctrl + H</kbd> | <kbd>Cmd + H</kbd> |
| Bold | <kbd>Ctrl + B</kbd> | <kbd>Cmd + B</kbd> |
| Italic | <kbd>Ctrl + I</kbd> | <kbd>Cmd + I</kbd> |
| Strikethrough | <kbd>Ctrl + -</kbd> | <kbd>Cmd + -</kbd> |
| Insert Link | <kbd>Ctrl + L</kbd> | <kbd>Cmd + L</kbd> |
| Insert Image | <kbd>Ctrl + K</kbd> | <kbd>Cmd + K</kbd> |
| Insert Emoji | <kbd>Ctrl + E</kbd> | <kbd>Cmd + E</kbd> |
| Create Table | <kbd>Ctrl + T</kbd> | <kbd>Cmd + T</kbd> |
| Toggle Code | <kbd>Ctrl + ;</kbd> | <kbd>Cmd + ;</kbd> |
| Toggle Comment | <kbd>Ctrl + /</kbd> | <kbd>Cmd + /</kbd>
| Toggle Blockquote| <kbd>Ctrl + '</kbd> | <kbd>Cmd + '</kbd> |
| Horizontal Rule | <kbd>Ctrl + Shift + _</kbd> | <kbd>Cmd + Shift + _</kbd> |

--------------------
54 changes: 27 additions & 27 deletions docs/LICENSE.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
# GNU GENERAL PUBLIC LICENSE
### Version 3, 29 June 2007

Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
Copyright (C) 2007 Free Software Foundation, Inc. [http://fsf.org/](http://fsf.org/)
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.

Preamble
## Preamble

The GNU General Public License is a free, copyleft license for
software and other kinds of works.
Expand Down Expand Up @@ -68,9 +68,9 @@ patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.

TERMS AND CONDITIONS
## TERMS AND CONDITIONS

0. Definitions.
### 0. Definitions.

"This License" refers to version 3 of the GNU General Public License.

Expand Down Expand Up @@ -109,7 +109,7 @@ work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.

1. Source Code.
### 1. Source Code.

The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
Expand Down Expand Up @@ -151,7 +151,7 @@ Source.
The Corresponding Source for a work in source code form is that
same work.

2. Basic Permissions.
### 2. Basic Permissions.

All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
Expand All @@ -176,7 +176,7 @@ Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.

3. Protecting Users' Legal Rights From Anti-Circumvention Law.
### 3. Protecting Users' Legal Rights From Anti-Circumvention Law.

No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
Expand All @@ -192,7 +192,7 @@ modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.

4. Conveying Verbatim Copies.
### 4. Conveying Verbatim Copies.

You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
Expand All @@ -205,7 +205,7 @@ recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.

5. Conveying Modified Source Versions.
### 5. Conveying Modified Source Versions.

You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
Expand Down Expand Up @@ -242,7 +242,7 @@ beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.

6. Conveying Non-Source Forms.
### 6. Conveying Non-Source Forms.

You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
Expand Down Expand Up @@ -340,7 +340,7 @@ documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.

7. Additional Terms.
### 7. Additional Terms.

"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Expand Down Expand Up @@ -404,7 +404,7 @@ Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.

8. Termination.
### 8. Termination.

You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
Expand Down Expand Up @@ -432,7 +432,7 @@ this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.

9. Acceptance Not Required for Having Copies.
### 9. Acceptance Not Required for Having Copies.

You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
Expand All @@ -443,7 +443,7 @@ modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.

10. Automatic Licensing of Downstream Recipients.
### 10. Automatic Licensing of Downstream Recipients.

Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
Expand All @@ -468,7 +468,7 @@ rights granted under this License, and you may not initiate litigation
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.

11. Patents.
### 11. Patents.

A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
Expand Down Expand Up @@ -537,7 +537,7 @@ Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.

12. No Surrender of Others' Freedom.
### 12. No Surrender of Others' Freedom.

If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
Expand All @@ -549,7 +549,7 @@ to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.

13. Use with the GNU Affero General Public License.
### 13. Use with the GNU Affero General Public License.

Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
Expand All @@ -560,7 +560,7 @@ but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.

14. Revised Versions of this License.
### 14. Revised Versions of this License.

The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
Expand All @@ -586,7 +586,7 @@ permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.

15. Disclaimer of Warranty.
### 15. Disclaimer of Warranty.

THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
Expand All @@ -597,7 +597,7 @@ PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

16. Limitation of Liability.
### 16. Limitation of Liability.

IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
Expand All @@ -609,7 +609,7 @@ PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.

17. Interpretation of Sections 15 and 16.
### 17. Interpretation of Sections 15 and 16.

If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
Expand All @@ -618,7 +618,7 @@ an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.

END OF TERMS AND CONDITIONS
END OF TERMS AND CONDITIONS

How to Apply These Terms to Your New Programs

Expand All @@ -645,7 +645,7 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>.
along with this program. If not, see [http://www.gnu.org/licenses/](http://www.gnu.org/licenses/).

Also add information on how to contact you by electronic and paper mail.

Expand All @@ -664,11 +664,11 @@ might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<http://www.gnu.org/licenses/>.
[http://www.gnu.org/licenses/](http://www.gnu.org/licenses/).

The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<http://www.gnu.org/philosophy/why-not-lgpl.html>.
[http://www.gnu.org/philosophy/why-not-lgpl.html](http://www.gnu.org/philosophy/why-not-lgpl.html).

0 comments on commit 69ac386

Please sign in to comment.