A highly modular and extremely configurable static content generator and toolkit.

Wyam is different.

It's a static content toolkit and can be used to generate web sites, produce documentation, create ebooks, and much more. Since everything is configured by chaining together flexible modules (that you can even write yourself), the only limits to what it can create are your imagination.

Star

Easy!

Recipes and themes make it easy to quickly generate different kinds of sites. Try a blog or docs to get started.

Flexible!

Use a configuration file to customize your generation process with tons of modules or your own code.

Powerful!

Embed the Wyam engine to add the power of static generation to your own applications.

Features


Usage


The easiest way to get started is to install as a .NET Core global tool and use a recipe and theme.

1. Download and install Wyam as a global tool:

dotnet tool install -g Wyam.Tool

2. Scaffold a new blog:

wyam new --recipe Blog

3. Edit the scaffolded files.

4. Build the blog with a theme:

wyam --recipe Blog --theme CleanBlog

To go deeper, read more about the underlying concepts and then read about configuration files and the available command line arguments. Then check out the full list of modules.

GitHub