smol-11ty-starter - GitLite

KO | EN

gitlite — search

#typescript #go #golang #android #rust #linux #nodejs #cli #kubernetes #vue #security #ios #openai #open-source

smol-11ty-starter

(★ 97)

Extremely minimal Eleventy starter to kickstart a simple multi-page site / a nearly opinionless foundation to continue building on.

File Explorer

Download Latest Version (.zip)

- - catpic.js
  - meta.js
- - base.njk
  - nav.njk
  - page.njk
- - style.css
- - page-one.md
  - page-two.md
  - pages.json
- index.md
.eleventy.js
.gitignore
package-lock.json
package.json
README.md

# Installation Guide

1. Get the code

git clone https://github.com/5t3ph/smol-11ty-starter

Downloads the entire project code from GitHub to your computer.

cd smol-11ty-starter

Moves into the project folder you just downloaded.

2. Node.js

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
Node.js Node.js must be installed to use npm. The LTS version is recommended.

npm install

Downloads and installs the libraries listed in package.json.

npm start

Starts the development/run server.

✅ After running the command, open the address shown in the terminal (usually something like http://localhost:3000) in your browser.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Smol Eleventy Starter

> Extremely minimal Eleventy starter to kickstart a simple multi-page site / a nearly opinionless foundation to continue building on.

### Quick Start

1. [Generate a repo from this template](https://github.com/5t3ph/smol-11ty-starter/generate) which will copy this project into your own new repo. _Note: You must be signed in to GitHub for this link to work_, else [visit the repo directly](https://github.com/5t3ph/smol-11ty-starter/).

1. Once cloned, run `npm install` to install 11ty. Then run `npm start` to run 11ty in `serve` mode which will create a local server including hot-reload via BrowserSync.

- Use `npm run build` to run a production version.

1. Open `src/_data/meta.js` and adjust the values to your details.

1. Edit `index.md` to change the home page, and then create content within `src/pages` using any templating format you prefer to add content.

> Review the resources available at [11ty Rocks](https://11ty.rocks) to learn how to apply more customizations, including adding custom data sources and reviewing what template languages are available.

## Learn More About Eleventy

- Get the highlights in my [14 minute feature overview](https://youtu.be/p81J7G1qFAM)
- Enjoy written tutorials? Start with my post on [creating your first Eleventy website](https://11ty.rocks/posts/create-your-first-basic-11ty-website/)
- Enjoy video tutorials? Learn to [build an Eleventy site including Sass](https://5t3ph.dev/learn-11ty) in my 20 minute egghead course

## Where to go from here?

- You may want to swap to [use Sass instead of CSS](https://github.com/5t3ph/11ty-sass-skeleton) and include minifying/autoprefixing (you can copy the relevant bits from the config and the package scripts/dependencies)
- Review [additional common config customizations](https://11ty.rocks/eleventyjs/)
- Check out some [quick tips](https://11ty.rocks/tips/) to learn more about using Eleventy's features
- Add automatically generated [social images with my plugin](https://www.npmjs.com/package/@11tyrocks/eleventy-plugin-social-images)