chris0stein / collections-example-video

Elevently Basic Starter

This is a minimal eleventy starter designed to have a similar structure to a basic web site. The repo owes a big thanks to Stephanie Eckles's Smol Eleventy Starter repository.

Quick Start

1. Generate a repo from this template which will copy this project into your own new repo. Note: You must be signed in to GitHub for this link to work

   The other option is to visit the repo directly and clone it. Generating is a smoother process and is recommended over direct cloning.

2. Once you have a copy of the repository on GitHub, Clone it to your local computer. There are a few options

   1. Use the Terminal – see this GitHub tutorial
   2. Use an editor like VS Code – see more info on VS Code and GitHub
   3. Use a program like GitHub Desktop for Windows/mac or Git Tower.

3. In your Editor, open the repository folder if you didn't already in the previous step. Remember to always open the folder and not individual files!

4. Open the Terminal and type, run npm install to install 11ty module and other dependent modules (you should see a new node_modules folder and package-lock.json file).

5. Then, also in the Terminal, run npm start to run 11ty in serve mode which will create a local server including hot-reload via BrowserSync. You will see a link to the localhost url in the terminal.

6. Open package.json and adjust the author values to your name. There are other things you can change, but maybe hold off until you know more about how package.json works.

7. Edit index.md to change the home page, and then create content within src folder.

8. If you are converting an existing site you can:

   1. Copy your CSS, JS and images into the respective folders
   2. Edit src/_includes/base.njk to inclue the parts of your site that are on every page (ie header, footer, links to css files, links to js files.)
   3. Create Markdown files in the src folder for your HTML files.

Learn More About Eleventy

• 11ty Official Site
• Stephanie Eckles site 11ty Rocks has a lot of information on 11ty. You can learn how to get started, apply custom data sources and more. Here are a few:
  • Get the 11ty highlights in her 14 minute feature overview
  • Read her post on creating your first Eleventy website
  • View the Quick Tips
  • View some configuration examples

Site and Longer Guides

• Beginner's Guid to Eleventy
• 11ty Recipes
• Learn Eleventy from Scratch note: while it says it’s out of date, the basics are all fine.