Skip to content

Demonstration of the Stencila VSCode Extension using GitHub Codespaces

License

Notifications You must be signed in to change notification settings

stencila/demo-codespace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Stencila VSCode Extension Demo

This demo creates a prepared Dockerized environment for testing Stencila, Stencila VSCode and Stencila Cloud without any changes to your workstation's environment. Stencila can also run locally by simply installing the Stencila VSCode extension in VSCode. The demo environment described below is an alternative available for those who do not want to install VSCode, but want to test out Stencila and Stencila Cloud.

Two ways to run :

1. Launching the demo in the Cloud (EASY!)

Our free tier will let you experiment with Stencila and try out our walkthroughs, or test on your own documents.

You can launch the demo, in a data center near you, by clicking this button:

Open in GitHub Codespaces

2. Launching the demo Locally using Docker and Dev Container (more steps)

Expand to see Instructions

This repository has a Dev Container defined in the .devcontainer directory of the repository. This defines a container that can run Stencila and the associated Stencila VSCode extension on your local machine in a containerized environment. To run locally (requires Docker).

  1. Install VSCode or have it already installed
  2. Install Docker or have it already installed
  3. Install the Dev Container Extension in VSCode
  4. git clone https://github.com/stencila/demo-codespace
  5. cd demo-codespace
  6. code .
  7. Chose "Reopen in Container from the pop-up in VSCode"
image

Interactive walkthroughs

When the Codespace is open we recommend trying one of our interactive walkthroughs. Press F2 to bring up the Stencila command palette and select from one of the walkthroughs.

Installed languages and packages

This Codespace includes Python and R with popular data science packages installed:

  • Python: numpy, matplotlib, pandas, requests

  • R: tidyverse

If you think we should add other languages or packages create an issue, or submit a PR with changes to the Dockerfile.

Customizing the Codespace

You can create a fork of this repository and modify the following files to customize the environment:

  • add language runtimes and packages to .devcontainer/Dockerfile

  • add VSCode extensions to .devcontainer/devcontainer.json

We are planning to make it easier to fork and customize this repository in the future.

About

Demonstration of the Stencila VSCode Extension using GitHub Codespaces

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published