https://github.com/amine7536/marko
Desktop Markdown editor with Live preview
https://github.com/amine7536/marko
Last synced: 4 months ago
JSON representation
Desktop Markdown editor with Live preview
- Host: GitHub
- URL: https://github.com/amine7536/marko
- Owner: amine7536
- License: mit
- Created: 2016-04-05T23:42:07.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2016-04-14T17:11:08.000Z (about 9 years ago)
- Last Synced: 2024-12-15T21:26:28.903Z (6 months ago)
- Language: JavaScript
- Homepage:
- Size: 859 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Marko
**/!\ alpha build / work in progress**
> Desktop Markdown editor with live preview
**Marko** is based on [React](https://facebook.github.io/react/), [Redux](https://github.com/reactjs/redux),
[React Router](https://github.com/reactjs/react-router), [Webpack](http://webpack.github.io/docs/),
[React Transform HMR](https://github.com/gaearon/react-transform-hmr).
## Install
First, clone the repo via git:
```bash
git clone https://github.com/amine7536/marko.git
```
And then install dependencies.
```bash
$ cd marko && npm install
```
## Run
Run this two commands __simultaneously__ in different console tabs.
```bash
$ npm run hot-server
$ npm run start-hot
```
or run two servers with one command
```bash
$ npm run dev
```
*Note: requires a node version >= 4 and an npm version >= 2.*
## DevTools
#### Toggle Chrome DevTools
- OS X: Cmd Alt I or F12
- Linux: Ctrl Shift I or F12
- Windows: Ctrl Shift I or F12
*See [electron-debug](https://github.com/sindresorhus/electron-debug) for more information.*
#### Toggle Redux DevTools
- All platforms: Ctrl+H
*See [redux-devtools-dock-monitor](https://github.com/gaearon/redux-devtools-dock-monitor) for more information.*
#### Redux Devtools Window
Now you can implement it using [remote-redux-devtools](https://github.com/zalmoxisus/remote-redux-devtools) with a [remote monitor](https://github.com/zalmoxisus/remote-redux-devtools#remote-monitoring) by yourself.
## Externals
If you use any 3rd party libraries which can't be built with webpack, you must list them in your `webpack.config.base.js`：
```javascript
externals: [
// put your node 3rd party libraries which can't be built with webpack here (mysql, mongodb, and so on..)
]
```
You can find those lines in the file.
## CSS Modules
This boilerplate out of the box is configured to use [css-modules](https://github.com/css-modules/css-modules).
All `.css` file extensions will use css-modules unless it has `.global.css`.
If you need global styles, stylesheets with `.global.css` will not go through the
css-modules loader. e.g. `app.global.css`
## Package
```bash
$ npm run package
```
To package apps for all platforms:
```bash
$ npm run package-all
```
#### Options
- --name, -n: Application name (default: ElectronReact)
- --version, -v: Electron version (default: latest version)
- --asar, -a: [asar](https://github.com/atom/asar) support (default: false)
- --icon, -i: Application icon
- --all: pack for all platforms
Use `electron-packager` to pack your app with `--all` options for darwin (osx), linux and win32 (windows) platform. After build, you will find them in `release` folder. Otherwise, you will only find one for your os.
`test`, `tools`, `release` folder and devDependencies in `package.json` will be ignored by default.
#### Default Ignore modules
We add some module's `peerDependencies` to ignore option as default for application size reduction.
- `babel-core` is required by `babel-loader` and its size is ~19 MB
- `node-libs-browser` is required by `webpack` and its size is ~3MB.
> **Note:** If you want to use any above modules in runtime, for example: `require('babel/register')`, you should move them from `devDependencies` to `dependencies`.
#### Building windows apps from non-windows platforms
Please checkout [Building windows apps from non-windows platforms](https://github.com/maxogden/electron-packager#building-windows-apps-from-non-windows-platforms).
## How hot-reloading works on Electron
We use [webpack-target-electron-renderer](https://github.com/chentsulin/webpack-target-electron-renderer) to provide a build target for electron renderer process. Read more information [here](https://github.com/chentsulin/webpack-target-electron-renderer#how-this-module-works).
## Maintainers
- [Amine Benseddik](https://github.com/amine7536)
## License
MIT © [Amine Benseddik](https://github.com/amine7536)