Local setup

Before you can make changes to the styles and scripts you'll need to get the site running locally with the 11ty dev server. There are two ways to do this; either install NVM and Node locally or use Lando.

Node running locally

To get the 11ty dev environment running locally you'll need to:

nvm install 18
nvm use
npm install
npm run start

This will install everything, build the site and start the dev server running at http://localhost:8080.

Node running in Lando

Rather than installing NVM and Node locally you can the dev environment in Lando.

With Lando installed run:

lando start
lando 11ty

The site should accessible at http://starterkit.lndo.site/

NPM scripts

There are a number of NPM scripts, defined in the site's package.json file, that should be used to build and run starter kit sites.

Run the commands with npm run {command} or lando npm run {command}.

build

Build the site for the production environment. An alias of build:production.

build:debug

Build the site for the development environment with the 11ty debug flag set.

build:development

Build the site for the development environment.

build:production

Build the site for the production environment.

build:stage

Build the site for the stage environment.

clean

Remove the dist build directory.

lint:docs

Run Markdownlint to check Markdown syntax.

lint:scripts

Run ESlint to check the JavaScript coding standards.

lint:styles

Run Stylelint to check CSS coding standards.

lint:templates

Run Markuplint to check Nunjucks coding standards.

start

Start 11ty dev server.

start:debug

Start 11ty dev server with the debug flag set.

start:lando

Start the 11ty dev server inside Lando.

Last updated: