Skip to content

/ stencila

Stencila
TypeScript Shell JavaScript Makefile
  1. TypeScript 75.9%
  2. Shell 14.0%
  3. JavaScript 9.5%
  4. Makefile 0.6%
Branch: master
Find file
Clone or download

Clone with HTTPS

Use Git or checkout with SVN using the web URL.

Open in Desktop Download ZIP

Latest commit

Fetching latest commit…
Cannot retrieve the latest commit at this time.

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode fix(Package): Update dependencies and refactor accordingly Sep 2, 2019
demos docs(Demos): update jupyter-notebook-demo, demo-overview, and examples. Jun 11, 2019
src feat(Zip archive): Add option to create a zip archive Sep 17, 2019
.appveyor.yml ci: Write Appveyor config for deployment Jun 6, 2019
.editorconfig fix(Package): Update dependencies and refactor accordingly Sep 2, 2019
.gitignore chore(Package): Update gitignore Sep 3, 2019
.prettierignore feat(Convert): Upgrade Encoda, allow for multiple convert output files Sep 10, 2019
.travis.yml ci(Travis): Update Travis config Sep 3, 2019
CHANGELOG.md chore(release): 0.33.5 Oct 11, 2019
HISTORY.md chore(*): Formatting Sep 3, 2019
LICENSE Moves everything from js/ subdir to top level, including merging READ… Mar 12, 2017
Makefile fix(Package): Update dependencies and refactor accordingly Sep 2, 2019
README.md docs(readme): add Greenkeeper badge Jun 13, 2019
build-test.sh tests: Add a test to check binary Jun 6, 2019
build-tgz.sh fix(Packaging): Fix to libary inclusion in macOS build Sep 15, 2019
install.sh fix: install.sh now works entirely inside /tmp directory Jun 11, 2019
package-lock.json build(deps): bump npm from 6.11.3 to 6.14.4 Mar 27, 2020
package.json chore(release): 0.33.5 Oct 11, 2019
tsconfig.json fix(Package): Update dependencies and refactor accordingly Sep 2, 2019

README.md

Stencila

Welcome to the main entry point to the Stencila ecosystem. This repo contains the stencila binary which is the top level 'umbrella' package to use our various libraries.

✨ We are are undergoing a major reboot in this repository (and many of our others) to build a single entry point for reproducible documents. We will deprecate stencila/cli and stencila/desktop and instead build those binaries here. We will also be deprecating binary builds of our other repositories as they are integrated into this one.

NPM Build status Code coverage Greenkeeper badge

Documentation

✨ As part of our reboot, documentation is forthcoming. Until then you can check the documentation for the libraries we have integrated so far:

Install

Stencila is available as a pre-compiled, standalone command line tool.

Windows

To install the latest release of the stencila command line tool, download stencila-win-x64.zip for the latest release and place it somewhere on your PATH.

MacOS

To install the latest release of the stencila command line tool to /usr/local/bin just use,

curl -L https://raw.githubusercontent.com/stencila/stencila/master/install.sh | bash

To install a specific version, append -s vX.X.X e.g.

curl -L https://raw.githubusercontent.com/stencila/stencila/master/install.sh | bash -s v0.33.0

Or, if you'd prefer to do things manually, download stencila-macos-x64.tar.gz for the latest release and then,

tar xvf stencila-macos-x64.tar.gz
sudo mv -f stencila /usr/local/bin # or wherever you like

Linux

To install the latest release of the stencila command line tool to ~/.local/bin/ just use,

curl -L https://raw.githubusercontent.com/stencila/stencila/master/install.sh | bash

To install a specific version, append -s vX.X.X e.g.

curl -L https://raw.githubusercontent.com/stencila/stencila/master/install.sh | bash -s v0.33.0

Or, if you'd prefer to do things manually, or place stencila elsewhere, download stencila-linux-x64.tar.gz for the latest release and then,

tar xvf stencila-linux-x64.tar.gz
mv -f stencila ~/.local/bin/ # or wherever you like

Development

npm install
npx ts-node-dev src/cli serve --sync
You can’t perform that action at this time.