Skip to content

MonkeyBuisness/cellementary-extension

Repository files navigation

VSCode Cellementary extension

cellementary-logo

The main purpose of this extension is to store and represent kernels for working with programming languages inside VS Code notebooks.

With this extension, you have a single interface for working with notebooks. The extension allows you to enable or disable the kernels you need. See the User Guide section for more information.

Installation

Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.

ext install <TODO: add id of the extension>

Or follow the marketplace link for more info.

User guide

Working with notebooks

Create a new file with the .*book extension. The list of supported notebook types you can find in the Supported language kernels section.

Create a code cell (click the +Code button) and paste any code.

If you need to add description to this code, you can create a markdown cell (click the +Markdown button) and paste any markdown text.

Select a kernel that supports this type of code and run the code cell to test it.

how-to-use-notebook

Most cell types support metadata. Within the metadata, you can provide specific fields that allow you to execute cell code in different ways.

You can also provide specific metadata for the notebook itself to change the way it interprets the contents of all cells inside.

NOTE: each notebook type supports its own metadata field types (for notebooks and cells). To see what fields you can provide, open the Kernel Information window from the Kernel Manager pane.

work-with-notebook-metadata

Managing kernels

To manage extension kernels (enable / disable / display info, etc) you need to open the Kernel Manager extension panel.

Kernel Manager

This panel allows you to manage installed kernels and view information about kernel usage.

work-with-kernel-manager

Supported language kernels

Language Notebook Types Supported Kernels
CSS htmlbook DHTML
Go gobook Go Local
Go Playground
HTML htmlbook DHTML
Java javabook Java One
Java Local
JavaScript htmlbook DHTML
JSON jsonbook JSON
JSONC jsonbook JSON
Markdown mdbook Markdown Basic
SQL sqlitebook
mysqlbook
SQLite
MySQL

Release Notes

[0.7.0]

  • Added kernel to work with htmlbook notebooks (DHTML)
  • Added kernel to work with javabook notebooks (Java One and Java Local)
  • Added kernel to work with json notebooks (JSON)
  • Added kernel to work with gobook notebooks (Go Local and Go Playground)
  • Added kernel to work with sqlitebook notebooks (SQLite)
  • Added kernel to work with mysqlbook notebooks (SQLite)
  • Added kernel to work with mdbook notebooks (Markdown Basic)

Contributing

If you want to improve this extension or fix a found bug, please follow this guide.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published