LightsaberProgressBar
A harmless progress bar that looks like a lightsaber. ๐ โญ .
Summary โข How To Use? โข Credits โข License
Summary
- LivePreview - Make changes, See changes
- Instantly see what your Markdown documents look like in HTML as you create them.
- Sync Scrolling
- While you type, LivePreview will automatically scroll to the current location you're editing.
- GitHub Flavored Markdown
- Syntax highlighting
- KaTeX Support
- Dark/Light mode
- Toolbar for basic Markdown formatting
- Supports multiple cursors
- Save the Markdown preview as PDF
- Emoji support in preview ๐
- App will keep alive in tray for quick usage
- Full screen mode
- Write distraction free.
- Cross platform
- Windows, Mac and Linux ready.
How To Use
To clone and run this application, you'll need Git and Node.js (which comes with npm) installed on your computer. From your command line:
# Clone this repository
$ git clone https://github.com/amitmerchant1990/electron-markdownify
# Go into the repository
$ cd electron-markdownify
# Install dependencies
$ npm install
# Run the app
$ npm start
Note: If you're using Linux Bash for Windows, see this guide or use node
from the command prompt.
๐ค Interactive vs. non-interactive mode
By default, release-it is interactive and allows you to confirm each task before execution:
On a Continuous Integration (CI) environment, or by using the -n
option, this is fully automated. No prompts are shown and the configured tasks will be executed. This is demonstrated in the first animation above. An overview of the default tasks:
Task | Option | Default | Prompt | Default |
---|---|---|---|---|
Ready (confirm version) | N/A | N/A | - | Y |
Show staged files | N/A | N/A | prompt.src.status |
N |
Git commit | src.commit |
true |
prompt.src.commit |
Y |
Git push | src.push |
true |
prompt.src.push |
Y |
Git tag | src.tag |
true |
prompt.src.tag |
Y |
GitHub release | github.release |
false |
prompt.src.release |
Y |
npm publish | npm.publish |
true |
prompt.src.publish |
Y |
The left columns are default options in non-interactive (or CI) mode.
The prompt.*
options on the right in the table are used for the default answers in interactive mode. You can still change the answer to either Y
or N
as the questions show up (or cancel the process with Ctrl-c
).
Also, if e.g. npm.publish
is false
, the related prompt (prompt.src.publish
) will not be shown (regardless of its default answer).
Credits
This software uses code from several open source packages.
- Electron
- Node.js
- Marked - a markdown parser
- showdown
- CodeMirror
- Emojis are taken from here
- highlight.js
License
MIT