A continuation of the awesome project Wyam created by Dave Glick since it's the only open-source, cross-platform .NET documentation project that I know of, except docFX. For Windows-only there is also Sandcastle.
Wyam2 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.
-
Download and install Wyam as a global tool:
dotnet tool install -g Wyam2.Tool -
Scaffold a new blog:
wyam2 new --recipe Blog -
Edit the scaffolded files.
-
Build the blog with a theme:
wyam2 --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 Wyam2.
For questions and everything else
- please open a new discussion on GitHub
- or chat on Gitter
- or on Matrix
For more details about how you can help this project, see this.
For details on building this project, see this.
- up to v2.2.9
- builds are provided by original project, Wyam
- dotnet tool is
Wyam.Toolandwyam
- from v3.0.0
- builds are provided by this fork Wyam2
- dotnet tool is called
Wyam2.Toolandwyam2
- Original project Wyam under MIT license.
- Portions of the IO support were originally inspired from Cake under MIT license.
- The RSS/Atom support was originally ported from WebFeeds under MIT license.
- Themes:
- Many other fantastic OSS libraries are used directly as NuGet packages, thanks to all the OSS authors out there!
