Giter Club home page Giter Club logo

zircon_paper_myst's Introduction

Notebooks Now! Submission Template

Made with MyST Binder

This submission template is for a markdown-based publication with additional supporting notebook and markdown files, as well as supporting data, bibliography, and MyST build configuration.

Source files

The primary source file for this template is a MyST markdown article. This file may reference notebook cells from other sub-articles to use the output of these cells as figures. It may also reference content from other markdown sub-articles. All of these supplementary source notebooks/articles should be saved in the notebooks/ folder. It also contains MyST blocks tagged in their metadata as "part": "abstract", or "part": "availability" - these cells will be extracted from the document and included as the specified part in the built output.

Supporting material

Supplementary data

By convention, all data should be saved in data/ directory. There is nothing magic about this directory; references to your data from your notebook must still specify the correct relative path.

Supplementary images

Similar to the data/ directory, images for figures should be specified in images/ directory.

Bibliography

Bibliography entries may be specified two ways, both described in the MyST docs. They may be listed explicitly in BibTeX format, by convention in the file references.bib, and referenced by key using a cite MyST role. They may also be specified as inline DOI links. These do not require full bibliographic information; the data is fetched implicitly on build from the DOI.

MyST configuration

A myst.yml file must be provided to configure notebook metadata and exports. This includes authors, affiliations, licenses, keywords, and much more.

Building output artifacts

To build PDF/JATS output from your source data, you must have the MyST Markdown CLI installed

npm install -g mystmd

Then build all exports defined in the myst.yml file:

myst build --all

zircon_paper_myst's People

Contributors

msghiorso avatar

Watchers

 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.