A starter repository for a blog web site using the Eleventy static site generator.
Clone or download
Latest commit 54d4d3a Sep 30, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
_11ty Fix a typo Sep 18, 2018
_data Upgrades to 0.4.0 and adds tag pages Jun 21, 2018
_includes Whitespace, adds fourth sample post Sep 30, 2018
about Upgrades to 0.4.0 and adds tag pages Jun 21, 2018
css Whitespace Sep 30, 2018
feed Add sitemap.xml Sep 24, 2018
img adding img dir to align with default eleventy.js settings and avoid e… May 20, 2018
posts Refactored latest posts and with a correct sort. Uses dates on posts … Sep 30, 2018
.editorconfig Adds editorconfig for my own sanity. Jan 29, 2018
.eleventy.js Refactored latest posts and with a correct sort. Uses dates on posts … Sep 30, 2018
.eleventyignore Adds a /tags/ to list all valid tags Aug 29, 2018
.gitignore Initial commit. Jan 17, 2018
.nvmrc Adds an .nvmrc for netlify deploys. Jan 25, 2018
.travis.yml Change default config to use pathPrefix: "/" and then use `--pathpref… Jan 26, 2018
404.md Add sitemap.xml Sep 24, 2018
LICENSE Updated license name Jan 29, 2018
README.md Adds Netlify stuff to the readme. Jan 26, 2018
archive.njk Refactored latest posts and with a correct sort. Uses dates on posts … Sep 30, 2018
index.njk Fix href on github pages Sep 30, 2018
netlify.toml Switch to debug for netlify deploy Jan 28, 2018
package.json Upgrades dependencies to latest. Sep 30, 2018
sitemap.xml.njk Add sitemap.xml Sep 24, 2018
tags-list.njk Adds a /tags/ to list all valid tags Aug 29, 2018
tags.njk Workaround for #15 Sep 13, 2018

README.md

eleventy-base-blog

A starter repository showing how to build a blog with the Eleventy static site generator.

Build Status

Demos

Getting Started

1. Clone this repository:

git clone https://github.com/11ty/eleventy-base-blog.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

5. Run Eleventy

npx eleventy

Or build automatically when a template changes:

npx eleventy --watch

Or in debug mode:

DEBUG=* npx eleventy

Implementation Notes

  • about/index.md shows how to add a content page.
  • posts/ has the blog posts but really they can live in any directory. They need only the post tag to be added to this collection.
  • Add the nav tag to add a template to the top level site navigation. For example, this is in use on index.njk and about/index.md.
  • Content can be any template format (blog posts needn’t be markdown, for example). Configure your supported templates in .eleventy.js -> templateFormats.
    • Because css and png are listed in templateFormats but are not supported template types, any files with these extensions will be copied without modification to the output (while keeping the same directory structure).
  • The blog post feed template is in feed/feed.njk. This is also a good example of using a global data files in that it uses _data/metadata.json.
  • This example uses three layouts:
    • _includes/layouts/base.njk: the top level HTML structure
    • _includes/layouts/home.njk: the home page template (wrapped into base.njk)
    • _includes/layouts/post.njk: the blog post template (wrapped into base.njk)
  • _includes/postlist.njk is a Nunjucks include and is a reusable component used to display a list of all the posts. index.njk has an example of how to use it.