https://github.com/Wyamio/Wyam

A modular static content and static site generator.
https://github.com/Wyamio/Wyam

Last synced: 12 days ago
JSON representation

A modular static content and static site generator.

• Host: GitHub
• URL: https://github.com/Wyamio/Wyam
• Owner: Wyamio
• License: mit
• Created: 2020-02-29T20:40:29.000Z (over 4 years ago)
• Default Branch: develop
• Last Pushed: 2023-07-26T19:13:21.000Z (over 1 year ago)
• Last Synced: 2024-08-01T02:26:07.684Z (3 months ago)
• Language: C#
• Size: 29 MB
• Stars: 141
• Watchers: 6
• Forks: 28
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-dotnet-core - Wyam - Modular static content and static site generator. (Frameworks, Libraries and Tools / CMS)
• fucking-awesome-dotnet-core - Wyam - Modular static content and static site generator. (Frameworks, Libraries and Tools / CMS)
• awesome-dotnet-core - Wyam - Modular static content and static site generator. (Frameworks, Libraries and Tools / CMS)
• awesome-dotnet-core - Wyam - 模块化静态内容和静态站点生成器。 (框架, 库和工具 / 内容管理系统CMS)

README

        
**Note** This project is essentially archived. Wyam has been rebranded and rebooted as [Statiq](https://github.com/statiqdev). New development is happening over at [Statiq.Framework](https://github.com/statiqdev/Statiq.Framework) and [Statiq.Web](https://github.com/statiqdev/Statiq.Web). If you have a cool feature request, please open them over there so I can make sure it's considered for Statiq. The issue tracker and code here will remain open in order to deal with any ongoing issues specific to Wyam.

---

# Wyam

[![Join the chat at https://gitter.im/Wyamio/Wyam](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/Wyamio/Wyam?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

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](https://wyam.io/recipes).

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](https://wyam.io/docs/concepts) and then read about [configuration files](https://wyam.io/docs/usage/configuration) and the [available command line arguments](https://wyam.io/docs/usage/command-line). Then check out the full list of [modules](https://wyam.io/modules).

For more information see [Wyam.io](https://wyam.io).

## Acknowledgements

* Portions of the IO support were originally inspired from [Cake](http://cakebuild.net) under an MIT license.

* The RSS/Atom support was originally ported from [WebFeeds](https://github.com/mckamey/web-feeds.net) under an MIT license.

* Many other fantastic OSS libraries are used directly as NuGet packages, thanks to all the OSS authors out there!