node package manager

stencila-node

Stencila for Node.js

NPM Build status Code coverage Dependency status Chat

Install

npm install stencila-node

Use

This package lets you run JavaScript code from inside Stencila Documents. First, you need to start serving the Stencila Host within this package. You can do that from inside Node.js:

const stencila = require('stencila-node')
stencila.host.start()

Or from the shell,

./node_modules/.bin/stencila-node

This will serve a Stencila Host on localhost. You can then open your Stencila Document from within the Stencila Desktop. The host will be automatically detected by the desktop app and you'll be able to execute Javascript code cells from within your documents.

More documentation is available at https://stencila.github.io/node.

Discuss

We love feedback. Create a new issue, add to existing issues or chat with members of the community.

Develop

Most development tasks can be run directly from npm or via make wrapper recipes.

Task npm et al make
Install and setup dependencies npm install make setup
Check code for lint npm run lint make lint
Run tests npm test make test
Run tests with coverage npm run cover make cover
Build documentation npm run docs make docs
Serve and watch docs for updates npm run docs-serve make docs-serve
Clean make clean

To get started, please read our contributor code of conduct, then get in touch, checkout the platform-wide, cross-repository kanban board or just send in a pull request!

Docs are published using Github Pages, so to update them after making changes run make docs, commit the updated docs and do a git push.

Tests are run on Travis and code coverage tracked at Codecov.