ESIPFed / science-on-schema.org

science-on-schema.org - providing guidance for publishing schema.org as JSON-LD for the sciences
Apache License 2.0
113 stars 33 forks source link

Migrate to jupyter-book for rendering #139

Open datadavev opened 3 years ago

datadavev commented 3 years ago

Jupyter-book is a markdown based documentation environment that plays well with github markdown and offers many extended capabilities that may be leveraged by Science-on-schema.org:

As a proof of concept the feature-jupyterbook branch in my fork uses plain markdown copied into a jupyterbook folder that is rendered on push using a GH Action.

In that POC, the Getting-Started guide was modified to use the jupyter-book markdown, while Dataset and DataRepository are untouched.

My impression is that this format could be used almost immediately, with progressive refinement as appropriate.

datadavev commented 3 years ago

Suggesting this for release 1.3 primarily to support inclusion of practical, executable examples within the guidelines.