Setup
Getting started
1. Requirements
From dendron.dev.setup
Go to text →
Setup
Before you begin, you need to make sure to have the following SDKs and tools:
- Node.js >= 12.0.0
- We recommend using a version in Active LTS
Backlinks
2. Clone and Install
git clone https://github.com/dendronhq/dendron-11ty
cd dendron-11ty
npm install
3. Run 11ty
From dendron.pro.dendron-11ty.quickstart
Go to text →
Setup
Start the server in preview
- cd to your workspace root
cd {workspace root}
npx dendron-cli buildSiteV2 --wsRoot . --stage dev --serve
Build notes for production
npx dendron-cli buildSiteV2 --wsRoot . --stage prod
Backlinks
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
2. Create links to the monorepo packages
Run yarn link inside the following packages
- @dendronhq/engine-server
- @dendronhq/common-server
- @dendronhq/common-all
3. Link monorepo to 11ty
Inside dendron-11ty, execute ./scripts/link.sh file
- NOTE: don't forget to watch the monorepo to compile changes
From dendron.dev.setup
Go to text →
Setup
To continuously compile all dependencies, run the following
./bootstrap/scripts/watch.sh
Backlinks
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
From dendron.pro.dendron-11ty.quickstart
Go to text →
Setup
- cd to your workspace root
cd {workspace root}
npx dendron-cli buildSiteV2 --wsRoot . --stage dev --serve