Link Search Menu Expand Document

Setup

Getting started

1. Requirements

Setup

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


dendron.contribute.dev

2. Clone and Install

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

3. Run 11ty

Setup

Start the server in preview

cd {workspace root}
npx dendron-cli buildSiteV2 --wsRoot .  --stage dev --serve

Build notes for production

npx dendron-cli buildSiteV2 --wsRoot .  --stage prod 

dendron.contribute.dev

Running with dendron monorepo

Dendron depends on a bunch of packages from the dendron monorepo. If you already have it installed and are working on monorepo components, you can link those components with 11ty to have live updates.

1. Setup Monorepo

  • see instructions here

Run yarn link inside the following packages

  • @dendronhq/engine-server
  • @dendronhq/common-server
  • @dendronhq/common-all

Inside dendron-11ty, execute ./scripts/link.sh file

  • NOTE: don't forget to watch the monorepo to compile changes

Setup

To continuously compile all dependencies, run the following

./bootstrap/scripts/watch.sh

dendron.contribute.dev

4. Run Dendron Cli

You can run this CLI on any valid workspace. There's a test workspace in dendron-11ty that is good to test against

cd dendron-11ty/fixtures/test-workspace

Setup

cd {workspace root}
npx dendron-cli buildSiteV2 --wsRoot .  --stage dev --serve

dendron.contribute.dev


dendron.contribute.dev