noahmulfinger / acetate

A flexible, fast and easy to extend static site generator for Node

Acetate

Acetate is a page generating framework for static websites. It is built to be easy to integrate into existing build processes and tools, easy to extend, and developer friendly.

Usage

Acetate is generally intended to be used with a build system like Grunt, Gulp, or NPM scripts. There are several sample repositories showing how to do this:

• Grunt - Coming soon
• Gulp - Coming soon
• Command-line/NPM scripts

Quickstart

It's also easy to get started with Acetate or integrate Acetate into an existing project:

1. Install the Acetate CLI: npm install acetate-cli -g
2. Create a new Node JS project: npm init
3. Install Acetate in your project npm install acetate --save-dev
4. Create a folder to hold the source of your site and create an index.md file. mkdir src && echo 'Hello Acetate.' > src/index.md
5. Start the local server: acetate server --open

Contributing

Please run npm test locally before you submit a PR. This will run the tests and check for semistandard style and lint with the ESLint recommended rules.

More details in the contributing guide.

License

MIT