Packages

Summary

This goes over all packages in the dendron monorepo

To understand how to navigate these packages, see the schema

User Facing

Dendron Plugin

From Plugin Core

Go to text →

This is the Dendron extension that is installed in VSCode

Dendron CLI

From Dendron CLI

Go to text →

The Dendron CLI exposes Dendron's functionality via the command line.

Internal

Dendron Engine

From Dendron Engine

Go to text →

The engine provides the core of most of Dendron's capabilities. This includes note lookup, markdown parsing, etc

Dendron Agent

From Dendron API Server

Go to text →

The API server is a local express server that runs on the users machine. It can be initialized by the Dendron CLI or the Dendron Plugin.

It is a wrapper around the Dendron Engine.

It is located at `$ROOT/packages/api-server``

It is also called the Dendron Agent.

Dendron Pods

From Pods Core

Go to text →

This has Pod (Private) related logic

Web Components

Dendron web components refer to the collection NextJS + React logic that is used for Dendron's frontend clients in VSCode and when publishing.

Dendron Nextjs Template

From NextJS Template

Go to text →

The Dendron NextJS Template is the foundation of Dendron's frontend. It is built around NextJS and React.

Children

Lookup

Dendron Next Server

No note with name pkg.dendron-next-server found

dendron-plugin-views

From Dendron Plugin Views

Go to text →

Responsible for webviews of dendron plugin core

Ant Design

We use Ant as our main design system in Dendron

Docs

Common

These packages are shared dependencies

Dendron Common All

From Common All

Go to text →

Types and utilities used in both web and node environments.

Dendron Common Server

From Common Server

Go to text →

Utilities for nodejs environment

Dendron Common Frontend

From Common Frontend

Go to text →

Shared frontend logic

Common Assets

From Common Assets

Go to text →

This packages hold assets for Dendron Views. During the build step, assets from this package are concatenated and copied into NextJS Template and Dendron Plugin Views (TODO: need to refactor logic from dendron-plugin-views, currently assets are being built separately there).

NOTE: we are currently moving away from dendron-next-server and transferring all css and assets from it to common-assets
- last updated: 2021-11-18