https://github.com/alensiljak/blacksmith-demo

Demo site for Blacksmith templating
https://github.com/alensiljak/blacksmith-demo

Last synced: about 2 months ago
JSON representation

Demo site for Blacksmith templating

• Host: GitHub
• URL: https://github.com/alensiljak/blacksmith-demo
• Owner: alensiljak
• Created: 2013-04-05T11:48:28.000Z (almost 12 years ago)
• Default Branch: master
• Last Pushed: 2013-05-22T10:48:25.000Z (over 11 years ago)
• Last Synced: 2024-04-14T14:29:36.444Z (9 months ago)
• Language: Shell
• Size: 199 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
blacksmith-demo

===============

Demo site for Blacksmith templating.

For more details on Blacksmith, check

https://github.com/flatiron/blacksmith

Install

=======

	npm install blacksmith -g

Run

===

Open console in the project directory (the one containing this file) and run build.cmd. This simply executes

	blacksmith

When Blacksmith is run, all the rendered content goes into 

/public

Directories

===========

"Pages" directory defines what goes into the page generation. The json files define which sections of the layout will be replaced by which partials. "Content" is replaced by the main partial, the one with the same name as the page.

"Layouts"

Layout templates for web pages. 

"Partials"

These are HTML fragments that can be inserted into a layout, a page, or another partial. Partials for each output HTML page are specified in Pages directory.

"Content"

Contains Markdown files with content. Think of them as posts or pages on the final site. This content is inserted into the templates.

Notes

=====

Index page uses content and, therefore, replaces content element with appropriate partial.

It is a single page so doesn't need a subdirectory in /content. Just index.md in the /content root.

Articles, on the other hand, are multiple output html pages created from one template page. That is why they are in a subdirectory, named as plural of article.

If metadata in content pages is not being correctly parsed and applied, make sure the (.md) file is saved with UTF-8 encoding.

Links

=====

Markdown syntax: http://daringfireball.net/projects/markdown/syntax