Getting Started
An overview of Embersmith, how to install it, project templates and commands.
Overview
Embersmith is a Node.js application that takes Markdown files from your project's /contents directory and converts them to HTML & JSON in /public directory.
Installation
If you don't already have Node.js installed, you can install it from Node.js website or with a package manager ( like Homebrew on Mac OS X ).
Run npm install -g embersmith
to install Embersmith.
Project Templates
Embersmith comes with 3 project templates:
- Ember Starter Kit for experiments and demos
- Ember App Kit for ambitious applications
- Docs - this site
Create a new project
You can create a project from command line with the embersmith create dir_name
(subsitute dir_name for name of the directory) command. This command will assume that you want to create an Ember Starter Kit based project.
To start an Ember App Kit based project, you have to tell the create command to use the appkit template. You can do this with -T appkit arguement. embersmith create -T appkit dir_name
Add to an existing project
To add Embersmith to an existing project,
{
"locals": {
"name": "",
"url": "",
"dev": "",
"description": "",
"keywords": ""
}
}
- create config.json
- create contents & templates directories in the root of your project
- create partials & helpers directories in templates directory
- (Optional)
npm install embersmith --save-dev
add save as dev dependancy in your project's package.json
Use with Grunt
For projects that use Grunt, you can use the grunt-embersmith package to automate starting and stoping your server. Add it to your projects with npm install grunt-embersmith.
Commands
Once you created a project, you can run Embersmith commands inside of your project directory.
embersmith preview
- starts preview serverembersmith build
- generate all of the pages into the build directory
embersmith
executable. It will give you very confusing results. Run grunt server
and embersmith:build task instead.