Giter VIP home page Giter VIP logo

markdown_science's Introduction

Markdown for scientific writing

Markdown is a fantastic and minimalist tool for authoring scientific documents. This repository is a collection of tools, resources, and tutorials to simplfy your workflow. If you spend a little time going through the tutorials you'll be able to stop using Microsoft Word entirely and write clean, lightweight markdown files that can easily be version controlled by git. Collaboration with your coauthors would also become way more powerful and simpler.

Copying this repo

If you have git installed, simply clone this repo and you'll have a full set of examples to work with. Otherwise just hit the zip button at the top to download a copy.

git clone https://github.com/karthik/markdown_science.git

Documentation

A full set of documentation is slowly coming together in the wiki. Feel free to contribute. If you have ideas for examples, add them to the repo and send in a pull request.

markdown_science's People

Contributors

karthik avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

markdown_science's Issues

A python(?) script to parse citations to the pandoc format

This would be useful to convert manuscripts written with a word processor with embedded citations in the format (Author1 YEAR1, Author2 YEAR2). You can copy&paste the text to an editor save the file and convert citations to [@Author1YEAR1; @Author2YEAR2]

Commanility for additional markup

For use with my own tools, I have created a number of markup elements which are very useful for scientific publishing -- mostly notable, author which is obvious and cite which we use to generate in text citations. This very thin piece of semantics is very useful and can be made to percolate through to the HTML layer, so it's easy to extract.

In one sense, it doesn't matter what the syntax is, but if it is shared, then it can minimize the need for tooling support, as well as increasing familiarity for authors.

For my usage, I simply make use of shortcodes like so: [author]Phillip Lord[/author]. A shared syntax, or failing that a shared vocabulary for this sort of markup would be a good thing.

Implementation example: Zotero ODF Scan

The group is probably fully aware of this one, but I'll point it out just in case:

http://zotero-odf-scan.github.io/zotero-odf-scan/

What the tool does is to implement drag-and-drop markers that provide (a) minimal human-readable cite details; (b) slots for adding prefix, suffix and pinpoint details; and (c) a machine-readable identifier for the full underlying metadata of the cited item.

The markers can be added to any text document, including Markdown documents. If the text is later converted to ODF format, the markers can be converted into fully linked, dynamic Zotero citations for final formatting.

There are compromises, of course: the tool is specific to Zotero; the markers link to a specific (set of) Zotero database(s); and conversion to ODF is a necessary precondition to producing final, formatted citations. In addition, the syntax used (with fields separated by pipe characters, for ease of parsing) may be awkward for some text processors to handle (specifically reStructuredText, where pipe characters are used in unrelated markup).

On the other hand, in terms of workflow it is hard to beat drag-and-drop for ease of use, and the tool is agnostic to the authoring environment -- if you can paste text into it, you can use it with Zotero.

Happy to answer questions or collab if there is interest.

Cloning of the repository

When using the command:

$git clone [email protected]:karthik/markdown_science.git

The terminal answer:

Cloning into 'markdown_science'...
Permission denied (publickey).
fatal: Could not read from remote repository.

Please make sure you have the correct access rights
and the repository exists.

I suggest to rather use:

$git clone https://github.com/karthik/markdown_science.git

In this case, it seems to work.

Cheers!

Guillaume

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.