Git Product home page Git Product logo

down-quark's Introduction

Down Quark

Down Quark is a cross-platform markdown editor built on top of Electron.

Tech stack:

Screenshot - Editing Electron docs folder

Install dependencies

The repository has two package.json files: one for setting up the dev environment and one for the app itself. This helps to keep dependencies separate for packaging.

First, install dev dependencies (Electron runtime and helpers as well as JS and CSS transpilers):

> npm install

To install app dependencies and rebuild native modules for the Electron runtime:

> npm run install-app

To enable Git integration

The nodegit package is set as an optional dependency as it takes a long time to compile (and may not compile at all on Windows). The install-app script ignores optional dependencies so nodegit won't be installed. If you want Git integration, install nodegit separately with:

> cd app
> npm install nodegit

To run in development mode

To start Down Quark:

> npm start

To watch for JS and CSS changes:

> npm run watch

Build for your platform

> npm run package

This will package Down Quark for your platform and architecture.

Requirements for building on Windows:

Issue building on Windows with Git integration

I haven't been able to build nodegit for Electron on Windows. The issue has been raised here: #738.

Down Quark?

Down Quark is a markdown editor built on Electron. The electron is an elementary particle of the standard model, as a quarks. Quarks come in 6 flavours: up, down, strange, charm, top and bottom.

down-quark's People

Contributors

doryphores avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.