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
This is the Dendron extension that is installed in VSCode
Dendron CLI
The Dendron CLI exposes Dendron's functionality via the command line.
Internal
Dendron Engine
The engine provides the core of most of Dendron's capabilities. This includes note lookup, markdown parsing, etc
Dendron Agent
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
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
The Dendron NextJS Template is the basis for Dendron's new publishing frontend. It is built around NextJS and React. You can read about the motivation and goals behind this project in this rfc.
Dendron Next Server
This is the next generation UI for the Dendron application
dendron-plugin-views
This is responsible for the webviews inside pkg.dendron-plugin (Private)
Ant Design
We use Ant as our main design system in Dendron
Common
These packages are shared dependencies
Dendron Common All
Types and utilities used in both web and node environments.
Dendron Common Server
Utilities for nodejs environment
Dendron Common Frontend
Shared frontend logic
Common Assets
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 tocommon-assets
- last updated: 2021-11-18
Templates
Children
- Schema
- API Publish
- Common All
- Common Assets
- Common Frontend
- Common Server
- Common Test Utils
- Dendron API Server
- Dendron CLI
- Dendron Common Frontend
- Dendron Engine
- Dendron Markdown Links
- Dendron Plugin Views
- Dev.to Pod
- Engine Test Utils
- Markdown Links
- NextJS Template
- Plugin Core
- Pods Core
- Template Publish GitHub Action
Backlinks