Permalink
Switch branches/tags
Nothing to show
Find file Copy path
1178f8b Sep 15, 2017
74 lines (68 sloc) 5.1 KB
Title: A simple to use, highly modular, and extremely configurable static content generator
NoSidebar: true
NoContainer: true
NoGutter: true
---
<div class="jumbotron jumbotron-intro">
<div class="container-background">
<div class="container">
<h1>A highly modular and extremely configurable static content generator and toolkit.</h1>
</div>
</div>
</div>
<div class="jumbotron jumbotron-description jumbotron-description-1">
<div class="container">
<p><h2><strong>Wyam is different.</strong></h2></p>
<p><h2>It's a <em>static content toolkit</em> 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.</h2></p>
<p class="text-center">
<a class="github-button" href="https://github.com/Wyamio/Wyam" data-icon="octicon-star" data-style="mega" data-count-href="/Wyamio/Wyam/stargazers" data-count-api="/repos/Wyamio/Wyam#stargazers_count" data-count-aria-label="# stargazers on GitHub" aria-label="Star Wyamio/Wyam on GitHub">Star</a>
<a href="https://twitter.com/wyamio" class="twitter-follow-button" data-show-count="false" data-size="large">Follow @@wyamio</a>
<script async defer id="github-bjs" src="https://buttons.github.io/buttons.js"></script>
<script>!function(d,s,id){var js,fjs=d.getElementsByTagName(s)[0],p=/^http:/.test(d.location)?'http':'https';if(!d.getElementById(id)){js=d.createElement(s);js.id=id;js.src=p+'://platform.twitter.com/widgets.js';fjs.parentNode.insertBefore(js,fjs);}}(document, 'script', 'twitter-wjs');</script>
</p>
</div>
</div>
<div class="jumbotron jumbotron-description jumbotron-description-2">
<div class="container">
<p><h1><i class="fa fa-rocket"></i> Easy!</h1></p>
<p><a href="/recipes">Recipes and themes</a> make it easy to quickly generate different kinds of sites. Try a <a href="/recipes/blog">blog</a> or <a href="/recipes/docs">docs</a> to get started.</p>
</div>
</div>
<div class="jumbotron jumbotron-description jumbotron-description-3">
<div class="container">
<p><h1><i class="fa fa-magic"></i> Flexible!</h1></p>
<p>Use a <a href="/docs/usage/configuration">configuration file</a> to customize your generation process with <a href="/modules">tons of modules</a> or your own code.</p>
</div>
</div>
<div class="jumbotron jumbotron-description jumbotron-description-4">
<div class="container">
<p><h1><i class="fa fa-cogs"></i> Powerful!</h1></p>
<p><a href="/docs/usage/embedding">Embed the Wyam engine</a> to add the power of static generation to your own applications.</p>
</div>
</div>
<div class="container">
<h1>Features</h1>
<hr />
<ul>
<li>Written in .NET and <a href="/docs/extensibility/writing-a-module">easily extensible</a></li>
<li><a href="/docs/usage/obtaining">Low ceremony</a> - download a zip file, unzip, and run</li>
<li>Flexible <a href="/docs/usage/configuration">script-based configuration</a> using the power of the .NET Compiler Platform (Roslyn)</li>
<li>Lots of <a href="/modules">modules</a> for things like <a href="/modules/readfiles">reading</a> and <a href="/modules/writefiles">writing</a> files, handling <a href="/modules/frontmatter">front matter</a>, manipulating <a href="/modules/meta">metadata</a>, and much, much more</li>
<li><a href="/modules/yaml">YAML</a> and <a href="/modules/json">JSON</a> parsers</li>
<li><a href="/modules/less">Less CSS compiler</a></li>
<li><a href="/modules/image">Image manipulation</a></li>
<li>Support for multiple templating languages including <a href="/modules/markdown">Markdown</a> and <a href="/modules/razor">Razor</a></li>
<li>Integrated <a href="/docs/usage/command-line#embedded-web-server">web server</a> for previewing output with <a href="/docs/usage/command-line#livereload">LiveReload</a> support</li>
<li>Integrated <a href="/docs/usage/command-line#file-watching">file watching</a> and regeneration</li>
<li>Full <a href="/docs/usage/configuration#nuget-packages">NuGet support</a></li>
<li><a href="/docs/usage/embedding">Embeddable engine</a></li>
<li><a href="/docs/resources/some-background">Cool name</a></li>
</ul>
<h1>Usage</h1>
<hr />
<p><strong><a href="https://github.com/Wyamio/Wyam/releases">Go download the latest version now</a></strong> (look at <em>Downloads</em> under each release). Then unzip the Wyam.zip archive. The easiest way to get started is to use a <a href="/recipes">recipe and theme</a>.</p>
<p><b>1.</b> Scaffold a new blog: <pre><code>wyam.exe new --recipe Blog</code></pre></p>
<p><b>2.</b> Edit the scaffolded files.</p>
<p><b>3.</b> Build the blog with a theme: <pre><code>wyam.exe --recipe Blog --theme CleanBlog</code></pre></p>
<p>To go deeper, read more about the <a href="/docs/concepts">underlying concepts</a> and then read about <a href="/docs/usage/configuration">configuration files</a> and the <a href="/docs/usage/command-line">available command line arguments</a>. Then check out the full list of <a href="/modules">modules</a>.</p>
</div>