astraloverflow / starter-11ty

A starter template for static generated blogs using 11ty

Starter-11ty

A starter template for static generated websites using 11ty

---

Quick Start

$ npx degit astraloverflow/starter-11ty#2023.06.03 my-new-website
$ cd my-new-website
$ npm install
$ npm run dev

---

NPM Scripts

npm run test

• Runs stylelint (see .stylelintrc.js) and eslint (see .eslintrc.js) to check files for syntax and coding style errors.

npm run format

• Runs Prettier to format all code to the same style. prettier-plugin-css-order and prettier-plugin-tailwindcss are also installed. See Prettier website for full list of supported languages. Best used with the Prettier plugin for your chosen editor.

npm run dev

• Runs 11ty in development mode and runs a development server.

npm run prod

• Runs 11ty in production mode and builds the project.

---

LICENSE

Unless you want to release your project into the public domain via CC0 (which this project does), you should replace the contents of LICENSE with a license of your choosing (MIT, BSD, GPL, etc.)

---

.gitignore

Inside of .gitignore you will find the following

# These files lock down the project's node dependencies
# You should remove whichever one you are using in your project
package-lock.json
yarn.lock

As the comment in the file says, you should remove one of those two lines if you want to use the "version locking" features of either one, especially if you are developing with other people or on multiple computers/servers or are using a CI.

---