cobweb/xmitter-11ty
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
212 Commits 1 Branch 0 Tags 8.3 MiB
XSLT 80.3%
Nunjucks 7.1%
JavaScript 6.6%
CSS 6%
2145a3169c
Go to file
Andrei Stoicescu 2145a3169c Update readme instructions for css and images 
The instructions should be changed to properly reflect the way css and
images are handled in the configuration.

At the moment the instructions reference css and png files being
handled via templateFormats, but in reality they're configured to be
located in special css and img directories and handled via
addPassthroughCopy().
2021-06-03 20:10:08 +03:00
_data Merge pull request #81 from Atlas48/master 2021-03-17 10:08:24 -05:00
_includes Align tags 2021-03-19 20:38:32 -05:00
.github Create FUNDING.yml 2019-07-02 14:29:37 -05:00
about Switches to use more obvious markup menu template for eleventy-navigation 2020-01-02 20:51:47 -06:00
css Align tags 2021-03-19 20:38:32 -05:00
feed Add missing colon to json.njk 2021-03-19 03:20:05 +01:00
img adding img dir to align with default eleventy.js settings and avoid error 2018-05-19 21:06:12 -04:00
posts Support spaces in tags in base blog. 2021-03-17 16:29:07 -05:00
.editorconfig Adds editorconfig for my own sanity. 2018-01-28 21:26:25 -06:00
.eleventy.js Support spaces in tags in base blog. 2021-03-17 16:29:07 -05:00
.eleventyignore Get rid of the _11ty folder—we don’t need it. 2020-07-27 15:18:51 -05:00
.gitignore Initial commit. 2018-01-16 21:08:47 -06:00
.nvmrc Use a newer Node 2020-10-16 14:34:09 -05:00
.travis.yml Upgrade node version in travis config 2020-10-16 14:37:58 -05:00
404.md Missed one for #63. 2021-03-17 10:33:58 -05:00
archive.njk Switches to use more obvious markup menu template for eleventy-navigation 2020-01-02 20:51:47 -06:00
index.njk Fixes #62. 2021-03-17 10:29:29 -05:00
LICENSE Updated license name 2018-01-28 21:27:50 -06:00
netlify.toml Switch to debug for netlify deploy 2018-01-27 23:44:29 -06:00
package.json Update RSS plugin 2021-03-19 21:11:17 -05:00
page-list.njk Updates to 0.8.1 2019-04-05 21:57:58 -05:00
README.md Update readme instructions for css and images 2021-06-03 20:10:08 +03:00
sitemap.xml.njk Use new eleventyExcludeFromCollections feature in 0.8.0: https://www.11ty.io/docs/collections/#option%3A-exclude-content-from-collections 2019-04-04 20:49:20 -05:00
tags-list.njk Support spaces in tags in base blog. 2021-03-17 16:29:07 -05:00
tags.njk Support spaces in tags in base blog. 2021-03-17 16:29:07 -05:00

README.md

eleventy-base-blog

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

Build Status

Demos

Deploy this to your own site

These builders are amazing—try them out to get your own Eleventy site in a few clicks!

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 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

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.
  • The css and png directories in the input directory are going to be copied without modification to the output, because they're passed to addPassthroughCopy().
  • 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.