| eleventyNavigation | ||||||
|---|---|---|---|---|---|---|
|
These examples assume local project installation instead of global installation.
# Searches the current directory, outputs to ./_site
npx @11ty/eleventyIf you’re using a global install of Eleventy, remove npx @11ty/ from the beginning of each command, like so:
# Global installation
eleventy# `npx @11ty/eleventy` is the same as:
npx @11ty/eleventy --input=. --output=_siteRead more about --input and --output.
A hypothetical template.md in the current directory would be rendered to _site/template/index.html. Read more at Permalinks.
# Use only a subset of template types
npx @11ty/eleventy --formats=md,html,ejs# Find out the most up-to-date list of commands (there are more)
npx @11ty/eleventy --help# Boot up a Browsersync web server to apply changes and
# refresh automatically. We’ll also --watch for you.
npx @11ty/eleventy --serve# Change the web server’s port—use localhost:8081
npx @11ty/eleventy --serve --port=8081{% callout "info" %}Important Note: Browsersync requires a <body> tag in your template for live-reload to work properly.{% endcallout %}
# Automatically run when input template files change.
# Useful if you have your own web server.
npx @11ty/eleventy --watch# Shhhhh—Don’t log so much to the console
npx @11ty/eleventy --quietRuns without writing to the file system. Useful when debugging.
# Run Eleventy but don’t write any files
npx @11ty/eleventy --dryrun# Override the default eleventy project config filename (.eleventy.js)
npx @11ty/eleventy --config=myeleventyconfig.jsYes, you can use the same input and output directories, like so:
# Parse and write Markdown to HTML, respecting directory structure.
npx @11ty/eleventy --input=. --output=. --formats=md{% callout "warn" %}Careful with --formats=html here! If you run eleventy more than once, it’ll try to process the output files too. Read more at the HTML template docs.{% endcallout %}