A modular static content and static site generator
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Dave Glick e674d45e96 Release prep 1 week ago
.vscode Adding VS Code build task 2 years ago
examples Some example test output cleanup from recent newline conversion 1 month ago
lib/System.CommandLine Replacing custom command line argument parsing with System.CommandLine (custom build for now until some pending PRs are merged) - resolves #168, #43 3 years ago
src Updates the JavaScriptEngineSwitcher and default Jint engine 2 weeks ago
tests Fixes a regression in AutoLink where it wasn't returning the same document if no replacements were performed (#786) 2 weeks ago
themes Removes BookSite recipe and Velocity theme (#764) 3 weeks ago
.editorconfig More code quality 3 months ago
.gitattributes Updated not to have LF 1 month ago
.gitignore Release prep 1 month ago
BUILDING.md Another small fix to building instructions 7 months ago
CONTRIBUTING.md Normalizing line endings 1 month ago
Directory.Build.props Normalizing line endings 1 month ago
LICENSE Lots of work on NuGet versioning, think I've got it now - also now copies NuGet content to input folder 3 years ago
README.md Removing AppVeyor 3 months ago
RELEASE Release prep 1 week ago
ReleaseNotes.md Release prep 1 week ago
SolutionInfo.cs Release prep 1 week ago
Wyam.jmconfig Big reorg of file structure to make projects easier to find 2 years ago
Wyam.sln Removing BookSite from sln 3 weeks ago
Wyam.sln.DotSettings Added DotSettings based on CONTRIBUTING.md, partially resolves #443. (#444) 2 years ago
azure-pipelines.yml Normalizing line endings 1 month ago
build.cake Bumping the test logger (again) 1 month ago
build.cmd Adding VS Code build task 2 years ago
build.ps1 Normalizing line endings 1 month ago
daveaglick.ruleset Normalizing line endings 1 month ago
digicert-davidglick.pfx New code signing cert 4 months ago
stylecop.json Add enforcement for style rules (#443) 2 years ago
wyam.ruleset More code quality 3 months ago

README.md

Wyam

Wyam is a simple to use, highly modular, and extremely configurable static content generator that 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.

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.

For more information see Wyam.io.

Acknowledgements

  • Portions of the IO support were originally inspired from Cake under an MIT license.
  • The RSS/Atom support was originally ported from WebFeeds under an MIT license.
  • Many other fantastic OSS libraries are used directly as NuGet packages, thanks to all the OSS authors out there!