A highly modular and extremely configurable static content generator and toolkit.
Wyam2 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.
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 Wyam2 engine to add the power of static generation to your own applications.
Features
- A continuation of the awesome Wyam project crafted by Dave Glick - just switch to Wyam2 packages and everything should work as before
- Written in .NET, cross-platform and easily extensible
- Low ceremony - download a zip file, unzip, and run
- Flexible script-based configuration using the power of the .NET Compiler Platform (Roslyn)
- Lots of modules for things like reading and writing files, handling front matter, manipulating metadata, and much, much more
- YAML and JSON parsers
- Less CSS compiler
- Image manipulation
- Support for multiple templating languages including Markdown and Razor
- Integrated web server for previewing output with LiveReload support
- Integrated file watching and regeneration
- Full NuGet support
- Embeddable engine
- Cool name
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 Wyam2.Tool2. Scaffold a new blog:
dotnet wyam2 new --recipe Blog3. Edit the scaffolded files.
4. Build the blog with a theme:
dotnet wyam2 --recipe Blog --theme CleanBlogTo 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.