Just a little Markdown-Editor created to write my Daily-Reports at work.
Used Electron and VueJS to create this little Application.
Tested on various Ubuntu/Debian based Systems, but any other will be fine!
I bundled Packages for the following distributions ( OS_ARCH ):
- darwin-x64
- linux-ia32
- linux-armv7l
- linux-x64
- mas-x64
- win32-ia32
- win32-x64
- Clone the repository
> git clone https://github.com/deathpoison/mpad.git
- Install js dependencies
> yarn
# or npm
> npm install
- Start unbundled application
> yarn run start
# or npm
> npm run start
- Bundle application
> yarn run build
# or npm...
> npm run build
# change to dist dir of your pc architecture and run "mPad" binary
> ./mPad
If you do not want to build this Application just download it from: Pre-Release v0.1.3
- Extract files
Extract tarball of your "OS_ARCH" from:
dist/"date %Y-%m-%d"_"date %s"/mPad-"OS_NAME"-"OS_ARCH".tar.gz
to location of your choice ( my is "~/app/mpad" )
- Add "mpad" to $PATH
For Ubuntu it's enough to create a symlink to binary file called "mpad" in: "~/bin"
If not create one or use the existing one
and adding the following to your .bashrc for persisten usage
PATH=$PATH:$HOME/bin
export PATH
Activate new .bashrc using:
> source ~/.bashrc
- [GNOME ONLY] Link to MimeType: text/markdown
add desktop shortcut -> gnome based systems "open with" dialog
create file "mpad.desktop" in /usr/share/applications/ with following content:
[Desktop Entry]
Name=mPad
Comment=Markdown Editor
Exec=mpad %f
MimeType=text/markdown
Type=Application
StartupNotify=true
Terminal=false
Categories=Editor;Markdown;Text;Electron;Vue;Webkit;
Verify yourself at Gnome Docs: Desktop Files
[GNOME ONLY] Open a FileBrowser and open a Markdown-file
[GNOME ONLY] choose "mPad" and start reading
Open a FileBrowser and right-click on a Markdown-File
choose "open file with"
choose an custom command and use "mpad"
Optionaly pass a file as argument to open directly from a shell
Ctrl +
e => Open Markdown-Editor
h => Open Help
o => Open File
n => New File // clear Editor
s => Save Document
q => Quit Application
David Crimi ~ LimeBlack
Electron
MarkedJS
VueJS
Electron-Context-Menu
Webkit
Sublime
Copyright (c) 2017-2020, David Crimi. (MIT License)
See LICENSE for more info.