Skip to content
No description, website, or topics provided.
HTML JavaScript CSS
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_data
_includes
admin
pages
posts
static/img
.eleventy.js
.eleventyignore
.gitignore
.nvmrc
404.md
LICENSE
README.md
netlify.toml
package.json
tags.njk
yarn.lock

README.md

Netlify Status

Eleventy Netlify Boilerplate

What is it?

A simple template for building a fast, static website using the Eleventy static site generator, with Netlify CMS baked-in, ready to deploy to Netlify in a couple of clicks.

Use it as a starter for your own projects or as an easy way to get started building websites with Eleventy.

Based on the Eleventy Base Blog repo (see there for additional info on Eleventy usage).

🔥 This project is featured on Netlify's official template showcase 🔥

Demo Site

Features

  • Sample pages and blog with tag support
  • Netlify CMS with editor previews (thanks @biilmann!)
  • CSS 2kb minified, inlined for fastest page render
  • Pre-builds and minifies your HTML
  • Responsive CSS Grid layout, with fallbacks (see Browser Support)
  • Uses Markdown files for content
  • Uses Liquid and/or Nunjucks templates for layout
  • 100% Javascript framework free
  • Optional pipeline for minified inline JS
  • Continuous Deployment workflow via Netlify

Want to try it out now?

Deploy to Netlify

Clicking the button above will deploy a copy of the demo website to your Netlify account (you can create an account during this process if you don't have one) and everything needed for running the CMS:

  • A new repository in your GitHub account with the code
  • Full Continuous Deployment to Netlify's global CDN network
  • Control users and access with Netlify Identity
  • Manage content with Netlify CMS
  • Process form data with Netlify Forms

Setup authentication

After deploying this project, Netlify Identity will add you as a CMS user and will email you an invite. It is not necessary to accept this invite if you wish to use an OAuth provider (e.g. Github) to manage authentication for your CMS. It is recommended to use this method of authentication as it removes the need for an email & password to log in to the CMS and is generally more secure. You will need to add an OAuth provider in your Netlify app settings under "Settings" > "Identity" > "External providers".

Once you've added an OAuth provider, navigate to /admin on your site, select your provider from the list, and you should then be logged into your CMS. Cool huh?

Now you're all set, and you can start editing content!

Gotchas

If you change the repo that was created at deploy time from public to private, you'll need to regenerate your token, as the token generated using the deploy to Netlify button can only access public repositories. To regenerate your token, head to "Settings" in your Netlify site dashboard, go to the "Identity" section, then scroll to "Services" where you'll see an "Edit settings" button. Click that and you'll see a text link to "Generate access token in GitHub".

If you need any help with setting up Netlify CMS, you can reach out to the Netlify team in the Netlify CMS Gitter.

Local development

1. Clone this repository:

git clone https://github.com/danurbanowicz/eleventy-netlify-boilerplate.git my-blog-name

2. Navigate to the directory

cd my-blog-name

Specifically have a look at .eleventy.js to see if you want to configure any Eleventy options differently.

3. Install dependencies

npm install

4. Edit _data/metadata.json

This file contains your site title and author details.

5. Run Eleventy (builds the site)

npx eleventy

Or build automatically when a template changes:

npx eleventy --watch

Or in debug mode:

DEBUG=* npx eleventy

Bug reports, feature requests, etc

This is an ongoing project and I welcome contributions. Feel free to submit a PR.

If you need any help with setting up Netlify CMS, you can reach out to the Netlify team in the Netlify CMS Gitter.

You can’t perform that action at this time.