From ccd8f03b7001a3528fa4c82f55c51136e7eab087 Mon Sep 17 00:00:00 2001 From: Zach Leatherman Date: Tue, 16 Jan 2018 21:38:57 -0600 Subject: [PATCH] Reorder docs --- README.md | 10 +++------- _includes/layouts/base.njk | 2 +- index.njk | 2 +- 3 files changed, 5 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index cd20c33..654f799 100644 --- a/README.md +++ b/README.md @@ -43,18 +43,14 @@ 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`. -* `about/index.md` shows how to add a content page. * 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). + * 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 macro and is used to display a list of all the posts. Use it like this: -``` -{% import "postlist.njk" as postsm %} -{{ postsm.list(collections.post, page) }} -``` +* `_includes/postlist.njk` is a Nunjucks macro and is a reusable component used to display a list of all the posts. `index.njk` has an example of how to use it. \ No newline at end of file diff --git a/_includes/layouts/base.njk b/_includes/layouts/base.njk index 4d1c288..9882f5e 100644 --- a/_includes/layouts/base.njk +++ b/_includes/layouts/base.njk @@ -11,7 +11,7 @@
diff --git a/index.njk b/index.njk index e6f000e..542a0da 100644 --- a/index.njk +++ b/index.njk @@ -5,5 +5,5 @@ tags: nav navtitle: Home --- {% import "postlist.njk" as postsm %} -{{ postsm.list(collections.post, page) }} +{{ postsm.list(collections.post) }}