Skip to content

Commit

Permalink
Switched references to 'metalsmith-templates' to 'metalsmith-layouts'…
Browse files Browse the repository at this point in the history
… in readme, jekyll, static-site, and wintersmith
  • Loading branch information
ansballard committed Oct 13, 2015
1 parent 9e69842 commit 66e0d87
Show file tree
Hide file tree
Showing 31 changed files with 61 additions and 61 deletions.
20 changes: 10 additions & 10 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ In Metalsmith, all of the logic is handled by plugins. You simply chain them tog
```js
Metalsmith(__dirname)
.use(markdown())
.use(templates('handlebars'))
.use(layoutslayouts('handlebars'))
.build(function(err) {
if (err) throw err;
});
Expand All @@ -21,7 +21,7 @@ Metalsmith(__dirname)
.use(drafts())
.use(markdown())
.use(permalinks('posts/:title'))
.use(templates('handlebars'))
.use(layoutslayouts('handlebars'))
.build(function(err) {
if (err) throw err;
});
Expand Down Expand Up @@ -54,9 +54,9 @@ Each plugin is invoked with the contents of the source directory, and each file
title: A Catchy Title
date: 2014-12-01
---

An informative article.

...would be parsed into...

```js
Expand Down Expand Up @@ -107,22 +107,22 @@ In addition to a simple [Javascript API](#api), the Metalsmith CLI can read conf
"metalsmith-drafts": true,
"metalsmith-markdown": true,
"metalsmith-permalinks": "posts/:title",
"metalsmith-templates": "handlebars"
"metalsmith-layouts": "handlebars"
}
}
```

And then just install `metalsmith` and the plugins and run the metalsmith CLI...

$ node_modules/.bin/metalsmith

Metalsmith · reading configuration from: /path/to/metalsmith.json
Metalsmith · successfully built to: /path/to/build

Or if you install them globally, you can just use:

$ metalsmith

Metalsmith · reading configuration from: /path/to/metalsmith.json
Metalsmith · successfully built to: /path/to/build

Expand Down Expand Up @@ -187,8 +187,8 @@ or an array of paths. Glob syntax is supported via
Get the global metadata. This is useful for plugins that want to set global-level metadata that can be applied to all files.

#### #path(paths...)
Resolve any amount of `paths...` relative to the working directory. This is useful for plugins who want to read extra assets from another directory, for example `./templates`.

Resolve any amount of `paths...` relative to the working directory. This is useful for plugins who want to read extra assets from another directory, for example `./layouts`.

#### #run(files, fn)

Expand Down Expand Up @@ -221,7 +221,7 @@ mode: 0764
rm -rf .
```

would be built with mode ```-rwxrw-r--```, i.e. user-executable.
would be built with mode ```-rwxrw-r--```, i.e. user-executable.


## Troubleshooting
Expand Down
4 changes: 2 additions & 2 deletions examples/jekyll/_posts/2012-08-20-first-post.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: First Post
date: 2012-08-20
template: post.html
layout: post.html
---

An interesting post about how it's going to be different this time around. I'm going write a lot more nowadays and use this blog to improve my writing.
An interesting post about how it's going to be different this time around. I'm going write a lot more nowadays and use this blog to improve my writing.
4 changes: 2 additions & 2 deletions examples/jekyll/_posts/2012-08-23-second-post.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Second Post
date: 2012-08-23
template: post.html
layout: post.html
---

A super-interesting piece of prose I had already written weeks ago.
A super-interesting piece of prose I had already written weeks ago.
4 changes: 2 additions & 2 deletions examples/jekyll/_posts/2012-09-28-third-post.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Third Post
date: 2012-09-28
template: post.html
layout: post.html
---

A slightly late, less interesting piece of prose.
A slightly late, less interesting piece of prose.
4 changes: 2 additions & 2 deletions examples/jekyll/_posts/2012-12-07-fourth-post.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Fourth Post
date: 2012-12-07
template: post.html
layout: post.html
---

A really short, rushed-feeling string of words.
A really short, rushed-feeling string of words.
4 changes: 2 additions & 2 deletions examples/jekyll/metalsmith.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@
"metalsmith-permalinks": {
"pattern": ":title"
},
"metalsmith-templates": {
"metalsmith-layouts": {
"engine": "swig",
"directory": "_layouts"
}
}
}
}
6 changes: 3 additions & 3 deletions examples/jekyll/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
"name": "jekyll-example",
"private": true,
"dependencies": {
"metalsmith": "^1.0.0",
"metalsmith-drafts": "0.0.1",
"metalsmith-templates": "^0.6.1",
"metalsmith-layouts": "^1.4.1",
"metalsmith-markdown": "^0.2.1",
"metalsmith-permalinks": "^0.1.0",
"swig": "^1.3.2",
"metalsmith": "^1.0.0"
"swig": "^1.3.2"
},
"scripts": {
"build": "metalsmith"
Expand Down
2 changes: 1 addition & 1 deletion examples/static-site/build/my-first-post/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
</head>
<body>
<h1>My First Post</h1>
<time>Sun Aug 19 2012 17:00:00 GMT-0700 (PDT)</time>
<time>Sun Aug 19 2012 19:00:00 GMT-0500 (Central Daylight Time)</time>
<p>An interesting post about how it&#39;s going to be different this time around. I&#39;m going write a lot more nowadays and use this blog to improve my writing.</p>

</body>
Expand Down
2 changes: 1 addition & 1 deletion examples/static-site/build/my-fourth-post/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
</head>
<body>
<h1>My Fourth Post</h1>
<time>Thu Dec 06 2012 16:00:00 GMT-0800 (PST)</time>
<time>Thu Dec 06 2012 18:00:00 GMT-0600 (Central Standard Time)</time>
<p>A really short, rushed-feeling string of words.</p>

</body>
Expand Down
2 changes: 1 addition & 1 deletion examples/static-site/build/my-second-post/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
</head>
<body>
<h1>My Second Post</h1>
<time>Wed Aug 22 2012 17:00:00 GMT-0700 (PDT)</time>
<time>Wed Aug 22 2012 19:00:00 GMT-0500 (Central Daylight Time)</time>
<p>A super-interesting piece of prose I had already written weeks ago.</p>

</body>
Expand Down
2 changes: 1 addition & 1 deletion examples/static-site/build/my-third-post/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
</head>
<body>
<h1>My Third Post</h1>
<time>Thu Sep 27 2012 17:00:00 GMT-0700 (PDT)</time>
<time>Thu Sep 27 2012 19:00:00 GMT-0500 (Central Daylight Time)</time>
<p>A slightly late, less interesting piece of prose.</p>

</body>
Expand Down
File renamed without changes.
File renamed without changes.
4 changes: 2 additions & 2 deletions examples/static-site/metalsmith.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
"metalsmith-permalinks": {
"pattern": ":title"
},
"metalsmith-templates": {
"metalsmith-layouts": {
"engine": "handlebars"
}
}
}
}
8 changes: 4 additions & 4 deletions examples/static-site/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
"name": "static-site-example",
"private": true,
"dependencies": {
"metalsmith-templates": "^0.6.1",
"metalsmith-markdown": "^0.2.1",
"metalsmith-permalinks": "^0.1.1",
"handlebars": "^2.0.0-alpha.2",
"metalsmith": "^1.0.0",
"handlebars": "^2.0.0-alpha.2"
"metalsmith-layouts": "^1.4.1",
"metalsmith-markdown": "^0.2.1",
"metalsmith-permalinks": "^0.1.1"
}
}
4 changes: 2 additions & 2 deletions examples/static-site/src/first-post.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: My First Post
date: 2012-08-20
template: post.html
layout: post.html
---

An interesting post about how it's going to be different this time around. I'm going write a lot more nowadays and use this blog to improve my writing.
An interesting post about how it's going to be different this time around. I'm going write a lot more nowadays and use this blog to improve my writing.
4 changes: 2 additions & 2 deletions examples/static-site/src/fourth-post.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: My Fourth Post
date: 2012-12-07
template: post.html
layout: post.html
---

A really short, rushed-feeling string of words.
A really short, rushed-feeling string of words.
4 changes: 2 additions & 2 deletions examples/static-site/src/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
---
template: index.html
---
layout: index.html
---
4 changes: 2 additions & 2 deletions examples/static-site/src/second-post.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: My Second Post
date: 2012-08-23
template: post.html
layout: post.html
---

A super-interesting piece of prose I had already written weeks ago.
A super-interesting piece of prose I had already written weeks ago.
4 changes: 2 additions & 2 deletions examples/static-site/src/third-post.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: My Third Post
date: 2012-09-28
template: post.html
layout: post.html
---

A slightly late, less interesting piece of prose.
A slightly late, less interesting piece of prose.
2 changes: 1 addition & 1 deletion examples/wintersmith/build/my-first-post/index.html
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html><html><head><title>My Blog</title></head><body><h1>My First Post</h1><time>Sun Aug 19 2012 17:00:00 GMT-0700 (PDT)</time><div><p>An interesting post about how it&#39;s going to be different this time around. I&#39;m going write a lot more nowadays and use this blog to improve my writing.</p>
<!DOCTYPE html><html><head><title>My Blog</title></head><body><h1>My First Post</h1><time>Sun Aug 19 2012 19:00:00 GMT-0500 (Central Daylight Time)</time><div><p>An interesting post about how it&#39;s going to be different this time around. I&#39;m going write a lot more nowadays and use this blog to improve my writing.</p>
</div></body></html>
2 changes: 1 addition & 1 deletion examples/wintersmith/build/my-fourth-post/index.html
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html><html><head><title>My Blog</title></head><body><h1>My Fourth Post</h1><time>Thu Dec 06 2012 16:00:00 GMT-0800 (PST)</time><div><p>A really short, rushed-feeling string of words.</p>
<!DOCTYPE html><html><head><title>My Blog</title></head><body><h1>My Fourth Post</h1><time>Thu Dec 06 2012 18:00:00 GMT-0600 (Central Standard Time)</time><div><p>A really short, rushed-feeling string of words.</p>
</div></body></html>
2 changes: 1 addition & 1 deletion examples/wintersmith/build/my-second-post/index.html
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html><html><head><title>My Blog</title></head><body><h1>My Second Post</h1><time>Wed Aug 22 2012 17:00:00 GMT-0700 (PDT)</time><div><p>A super-interesting piece of prose I had already written weeks ago.</p>
<!DOCTYPE html><html><head><title>My Blog</title></head><body><h1>My Second Post</h1><time>Wed Aug 22 2012 19:00:00 GMT-0500 (Central Daylight Time)</time><div><p>A super-interesting piece of prose I had already written weeks ago.</p>
</div></body></html>
2 changes: 1 addition & 1 deletion examples/wintersmith/build/my-third-post/index.html
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html><html><head><title>My Blog</title></head><body><h1>My Third Post</h1><time>Thu Sep 27 2012 17:00:00 GMT-0700 (PDT)</time><div><p>A slightly late, less interesting piece of prose.</p>
<!DOCTYPE html><html><head><title>My Blog</title></head><body><h1>My Third Post</h1><time>Thu Sep 27 2012 19:00:00 GMT-0500 (Central Daylight Time)</time><div><p>A slightly late, less interesting piece of prose.</p>
</div></body></html>
4 changes: 2 additions & 2 deletions examples/wintersmith/contents/first-post.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: My First Post
date: 2012-08-20
template: post.jade
layout: post.jade
---

An interesting post about how it's going to be different this time around. I'm going write a lot more nowadays and use this blog to improve my writing.
An interesting post about how it's going to be different this time around. I'm going write a lot more nowadays and use this blog to improve my writing.
4 changes: 2 additions & 2 deletions examples/wintersmith/contents/fourth-post.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: My Fourth Post
date: 2012-12-07
template: post.jade
layout: post.jade
---

A really short, rushed-feeling string of words.
A really short, rushed-feeling string of words.
4 changes: 2 additions & 2 deletions examples/wintersmith/contents/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
---
template: index.jade
---
layout: index.jade
---
4 changes: 2 additions & 2 deletions examples/wintersmith/contents/second-post.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: My Second Post
date: 2012-08-23
template: post.jade
layout: post.jade
---

A super-interesting piece of prose I had already written weeks ago.
A super-interesting piece of prose I had already written weeks ago.
4 changes: 2 additions & 2 deletions examples/wintersmith/contents/third-post.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: My Third Post
date: 2012-09-28
template: post.jade
layout: post.jade
---

A slightly late, less interesting piece of prose.
A slightly late, less interesting piece of prose.
4 changes: 2 additions & 2 deletions examples/wintersmith/metalsmith.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@
"metalsmith-permalinks": {
"pattern": ":title"
},
"metalsmith-templates": {
"metalsmith-layouts": {
"engine": "jade",
"directory": "./templates"
}
}
}
}
4 changes: 2 additions & 2 deletions examples/wintersmith/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
"dependencies": {
"jade": "^1.3.0",
"metalsmith": "^1.0.0",
"metalsmith-layouts": "^1.4.1",
"metalsmith-markdown": "^0.2.1",
"metalsmith-permalinks": "^0.1.0",
"metalsmith-templates": "^0.6.1"
"metalsmith-permalinks": "^0.1.0"
}
}

0 comments on commit 66e0d87

Please sign in to comment.