Skip to content

Source Code Organization

AJ Keller edited this page Dec 3, 2019 · 1 revision

Visual Studio Code consists of a layered and modular core (found as src/vs) that can be extended using extensions. Extensions are run in a separate process referred to as the extension host. Extensions are implemented by utilizing the extension API.

Layers

The src is partitioned into the following layers:

  • api: Provides firebase and websocket support
  • skills: Defines a way to create skills that run on the Notion device
  • timesync: Provides a means to time sync between multiple clients and Notion
  • types: Define different types that are used within the project.
  • utils: Provides utility functions that are used across the layers

Examples

The examples is in two different categories:

  • browser: which show how to use various aspects of NotionJS in the web browser
  • node: provides examples of how to use NotionJS in NodeJS

Docs

The docs is partitioned into the following layers:

  • root-level: getting started, resources and a hello world tutorial
  • api: Provide an document for every public API endpoint for NotionJS
  • guides: Provide comprehensive guides to demonstrate how to use multiple API endpoints to create applications