Giter Club home page Giter Club logo

documents's Introduction

My Reproducible Documents

Hello. Do you have 10 minutes to help us test a new open collaboration workflow for reproducible scientific documents?

Spoiler: We'll be using Git for sharing and versioning and Stencila Desktop for editing.

  1. First clone this repo (or even better use your own fork).

    $ git clone https://github.com/michael/documents.git
    
  2. Open Stencila Desktop.

    This will soon be just an app download. But until then install and run the development version like so:

    $ git clone https://github.com/stencila/desktop.git
    $ cd desktop
    $ npm install
    $ npm start
    

    NOTE: You must have Node.js installed.

  3. Navigate to .../documents/welcome-to-stencila and open for editing.

  4. Now add a paragraph to the button of the document, save the changes and consider pushing them to your fork and submitting a Pull Request on Github. I will merge asap!

ATTENTION: With this workflow you are likely to experience merge issues, as Git does not work well with XML content. There are tools to help with merging XML. In the long run we will additionally provide realtime collaboration, and automated merging of XML diffs.

Please post any feedback in the Stencila Community Forum.

Merci! :)

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.