• Stars
    star
    321
  • Rank 127,567 (Top 3 %)
  • Language
    JavaScript
  • License
    Other
  • Created over 11 years ago
  • Updated over 8 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Markdown editor for scientific writing. Batteries included.

Markx

Markdown editor for scientific writing. Batteries included.

Why Markx?

Markdown has recently become popular among academics as a way to produce scientific documents. When paired with document conversion engines such as pandoc, it provides an easy and powerful way to write. Being a simple plain-text markup language, Markdown is easy to learn, and can be handled by version control systems. We decided to build Markx as to make markdown writing a collaborative effort that could be hosted as web service. For additional discussion, see these blog posts:

Features

  1. Free as in free speech - promotes open science, pre-publication review, collaboration.

  2. Free as in free beer - uses open-source, free software and released under CC-NC-BY 3.0.

  3. Easy to learn - Markdown is not LaTex, for better and worse.

  4. Integration with GitHub - free hosted version control, ideal for backup, versioning and collaboration.

  5. Pandoc integration - multiple Markdown extensions, multiple output formats.

  6. Real-time Markdown preview - WYSIWYM / WYSIWYG.

  7. Display math with LaTeX formatting - $x^2+y^2=r^2$.

  8. Citations - BibTeX: [@Drake1991]

  9. Code highlighting:

     if __name__ == '__main__':
         # Bind to PORT if defined, otherwise default to 5000.
         port = int(os.environ.get('PORT', 5000))
         app.run(host='0.0.0.0', port=port, debug=app.debug)
    
  10. Local host option with a limited number of dependencies - for offline editing on the train and in the airplane

  11. Remote host option at http://markx.herokuapp.com/ - no installation required

  12. By scientists, for scientists

Development Status

Markx is currently in development but can be used locally (see Installation instructions below) or remotely at http://markx.herokuapp.com.

It is still experimental, so take care of your data!

We would love to get feedback from anyone using it - Please open an issue with any bug or suggestion. If you can't open an issue please contact Yoav on twitter (you can use the #markx hashtag).

Technology

Install locally

  1. Clone this repository
  2. Install Python - developed with version 2.7
  3. Install Flask and requests: pip install Flask requests
  4. Optionally install Pandoc
  5. Run Markx by calling python server.py and pointing your browser at http://localhost:5000.
  6. Load a BibTeX file with your citation library by choosing Load a Bibliography File from the Bibliography menu

More help can be found in the help file.

License

More Repositories

1

CS1001.py

Recitation notebooks for Extended Introduction to Computer Science with Python as Tel-Aviv University
Jupyter Notebook
178
star
2

Py4Eng

Python for Engineers
Jupyter Notebook
24
star
3

DataSciPy

Data Science with Python
Jupyter Notebook
23
star
4

SciComPy

An introduction to Scientific Computing with Python, an advanced course for computer science students at IDC Herzliya
Jupyter Notebook
19
star
5

curveball

Predicting microbial growth in a mixed culture from growth curve data
Python
13
star
6

UnderTheRug

Repo for "Evolution on rugged adaptive landscapes"
Jupyter Notebook
11
star
7

Frodo

A web app for monitoring Sun Grid Engine (SGE) cluster status
Python
11
star
8

PyConIL2016

How to Study Evolution Using Scientific Python - PyCon Israel 2016
Jupyter Notebook
10
star
9

old-blog

My blog
CSS
7
star
10

rsvp

Quick and dirty RSVP web app
Python
5
star
11

ipython-notebooks

My scattered Jupyter notebooks
Jupyter Notebook
5
star
12

hello-citeproc

A simple citeproc-js web app
JavaScript
4
star
13

DataTalks2017

Talk about Scientific Python and Evolution | DataTalks #3 at Neura
2
star
14

subaru

auto-sub: automatic subtitle downloader
Python
2
star
15

smt_test

A simple Python simulation to test the Sumatra Simulation Management Tool
Python
2
star
16

manu

Everybody's a critic
Python
1
star
17

CommunityEcologyProject

A project for community ecology course using Human Microbiome Project data
R
1
star
18

BRD

Best response dynamics for male-female games
Python
1
star
19

TheoPopBiol

1
star
20

thesis

My PhD thesis
Batchfile
1
star
21

Plato

Tiny web app to design microplates and download them as a dataframe CSV
HTML
1
star
22

ultrachronic

Run parallel jobs and save results to json.gz files
Python
1
star
23

SanJose

Adaptive social contact rates induce complex dynamics during epidemics
Jupyter Notebook
1
star
24

mamba

Evolutionary simulations in Python
Python
1
star
25

thecitadel

Python
1
star
26

Sid

Image processing for seed images
Python
1
star
27

spidermail

Collect email addresses from websites (for academic purposes only)
Python
1
star
28

CompModBiol

Seminar: Computational Models in Biology, School of Computer Science, IDC Herzliya, Spring 2019
1
star
29

GrowthRatesPy

Python API for GrowthRates (Hall et al. 2014)
Python
1
star
30

ipy-progressbar

Progressbar for both IPython Notebooks (HTML, CSS, JS) and plain terminals.
Jupyter Notebook
1
star
31

docvertme

A web UI for Docverter
Python
1
star
32

goldensphinx

Build and serve Sphinx docs
Python
1
star