A starter repository showing how to build a blog with the Eleventy static site generator with a commenting system powered by Staticman.
This example uses Netlify Functions to run Staticman, so while it's possible to run it on any deployment provider, the easiest way to get up and running is to deploy with Netlify.
You'll be asked for some parameters during setup:
GitHub access token: A GitHub Personal Access Token used by Staticman to push new comments to your repository on your behalf. See this guide on how to create one.
Repository name: The name of your GitHub repository, including your username or organization (e.g.
reCAPTCHA site key and reCAPTCHA site secret: If you want to use reCAPTCHA to protect your form against spam attacks, you should insert your site key and secret, which you can obtain here. If you don't want to use reCAPTCHA, you can leave these blank.
1. Clone this Repository
git clone https://github.com/eduardoboucas/eleventy-blog-staticman.git my-blog-name
2. Navigate to the directory
Specifically have a look at
.eleventy.js to see if you want to configure any Eleventy options differently.
3. Install dependencies
4. Edit _data/metadata.json
5. Run Eleventy
Or build and host locally for local development
npx eleventy --serve
Or build automatically when a template changes:
npx eleventy --watch
Or in debug mode:
DEBUG=* npx eleventy
about/index.mdshows how to add a content page.
posts/has the blog posts but really they can live in any directory. They need only the
posttag to be added to this collection.
- Add the
navtag to add a template to the top level site navigation. For example, this is in use on
- Content can be any template format (blog posts needn’t be markdown, for example). Configure your supported templates in
pngare listed in
templateFormatsbut 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
- This example uses three layouts:
_includes/layouts/base.njk: the top level HTML structure
_includes/layouts/home.njk: the home page template (wrapped into
_includes/layouts/post.njk: the blog post template (wrapped into
_includes/postlist.njkis a Nunjucks include and is a reusable component used to display a list of all the posts.
index.njkhas an example of how to use it.