README.md

Truffle Suite website - http://truffleframework.com

This is a Metalsmith project.

Much of the static build process is coded by hand, to reflect the previous build system, Harp.js. All of this is coded in a middleware-like structure in metalsmith.js.

Development

Make sure you have run npm install in the root directory to install all dependencies.

To run a local server to view the site (available on localhost:9000), in the root directory run:

npm run dev

To compile the site, in the root directory, run:

npm run compile

Running the compile step will build the site and place it in the build/ directory.

Contributing

We welcome all contributions, typo corrections, and general feedback.

You can find the markdown source code inside the public/ subdirectory.

For example:

• For tutorials see public/tutorials.

• For docs see public/docs.

Commits to master (and PRs accepted) will trigger updates to the live site. Thank you!