Link Search Menu Expand Document

Setup

Getting Started

Before you begin, you need to make sure to have the following SDKs and tools:

The basic commands to get the repository cloned and built locally follow:

git clone https://github.com/dendronhq/dendron.git
cd dendron
npm install

Build Code Plugin

  • you should run this when building dendron for the first time and also every time you run a git pull
    • new dependencies might have been picked up between pulls and this makes sure that they are installed
./bootstrap/scripts/init.sh
  • we recommend you use vscode to develop for dendron. there is a dendron.code-workspace file in the root of the monorepo that you should use when developing

Advanced

You shouldn’t need to use this in case something goes wrong with a build step or you want to save time by not running everything, init.sh is just a thin wrapper around the following scripts, each of which can be run individually

  • ./bootstrap/scripts/bootstrap.sh: lerna bootstrap all packages
  • ./bootstrap/scripts/build.sh: lerna build all packages
  • initialize template repo (this bundles the latest dendron-template with the plugin so that the right notes are initialized when a user creates their first workspace)
 cd packages/plugin-core/
 ./scripts/sync_vault.sh

Developing

To continuously compile all dependencies, run the following

./bootstrap/scripts/watch.sh

Testing

Debugging