Releases: Wyamio/Wyam
Releases · Wyamio/Wyam
v1.6.0
- [Refactoring] Big update to Buildalyzer which should make MSBuild-based project introspection for docs much more reliable
- [Fix] Fixes a bug with docs
NoTitle
not working correctly - [Feature] Adds support for linking generic type arguments (#707, #709)
- [Fix] Fix for generic type argument names (#709)
- [Fix] Fix for a bug when linking nullable types in docs recipe
Please see https://wyam.io/docs/usage/obtaining for important notes about downloading and installing.
v1.5.1
- [Refactoring] Updated Cake.Wyam Cake reference to 0.28.0 (#701)
- [Refactoring] Added NuGet repository link to packages (#705, #706, thanks @MaximRouiller)
- [Feature] Better display and linking of nullable type in docs (#470)
- [Fix] Fixes for generic type parameters in docs (#702, #610)
Please see https://wyam.io/docs/usage/obtaining for important notes about downloading and installing.
v1.5.0
- [Breaking Change][Refactoring] Removed the
TextGeneration
module since it's not .NET Core compatible - [Fix] Set
wyam.exe
tox64
to avoid problems withNuGet.Build.Tasks.dll
, libuv, and .NET Framework (#699) - [Feature] Updated Buildalyzer/MSBuild for
CodeAnalysis
modules, documentation project builds should work more reliably and on more project types now - [Refactoring] Updated version of lunrjs used by the
SearchIndex
module and related themes (#660, #661, thanks @SteveLowe) - [Fix] Added support for no trailing slash on edit link URL in
Docs
theme (#698, thanks @Foxtrek64) - [Fix] Fixed a JavaScript console error in the Stellar theme (#685, thanks @jdecarli)
- [Fix] Removed unintentional Google Analytics code from Stellar theme (#684, thanks @jdecarli)
- [Fix] Fixes for tag archive links in all themes when using a subdirectory (#590, #681, thanks @schulz3000)
- [Fix] Fixed problems loading F# projects for code analysis and documentation generation (#687)
- [Fix] Fixed some assembly loading problems with
System.Text.Encodings.Web
(#667) - [Feature] Added a
Sitemap
pipeline to theBlog
recipe (#680, thanks @schulz3000) - [Feature] Added methods to specify additional word separators in the
AutoLink
module - [Feature] Added ability for
Docs
recipe to auto-link generic types (#674, #679, thanks @k94ll13nn3) - [Feature] Added an
--ignore-default-sources
option to ignore the NuGet gallery (#673, #662) - [Feature] Added
InsertPrefix()
andInsertSuffix()
toFilePath
- [Fix] Encodes type names when linking them in the
Docs
recipe (#674, #676, thanks @k94ll13nn3) - [Fix] Fixes some edge-case bugs with root-like paths and recipes (#675)
- [Refactoring] Replaced Tabular with EPPlus and CsvHelper in tables modules (#672, thanks @MisinformedDNA)
- [Refactoring] Replaced ImageProcessor with ImageSharp in
Image
module (#671, thanks @MisinformedDNA) - [Fix] Fix for hard coded blog path in some parts of
Docs
recipe (#670, thanks @tbolon) - [Fix] Fixed problems with month and day names in date strings (#655, thanks @jonasdoerr)
Please see https://wyam.io/docs/usage/obtaining for important notes about downloading and installing.
v1.4.1
- [Fix] Fixed missing known extensions which should help make future version updates smoother (#652)
- [Feature] Added ability to turn on binary logging from MSBuild for
CodeAnalysis
modules - [Feature] Updated Buildalyzer/MSBuild for
CodeAnalysis
modules
Please see https://wyam.io/docs/usage/obtaining for important notes about downloading and installing.
v1.4.0
Despite the small change log, this was a huge release. Thanks in part to the hard work of @pauldotknopf, almost all of the Wyam libraries are now targeting .NET Standard. This puts us within reach of .NET Core and cross-platform support soon. A lot changed under the hood, so please keep an eye out and report any problems you encounter.
- [Refactoring] Totally rewrote assembly loading
- [Refactoring] Converted a bunch of support and extension libraries to .NET Standard (#646, thanks @pauldotknopf)
Please see https://wyam.io/docs/usage/obtaining for important notes about downloading and installing.
v1.3.0
- [Refactoring] Configuration caches will always append to original configuration file ("config.wyam.dll", "config.wyam.hash", "config.wyam.packages.xml", etc.) (#619) - Note while this isn't a breaking change, it may require you to change your
.gitignore
files to handle the revised cache file names - [Fix] Graceful handling of missing cached config dll file (#617)
- [Refactoring] Trace settings at startup as verbose (#618)
- [Feature] Added an overload to
Replace
module that allows using the document in the content finder delegate (#625) - [Fix] Switches to
Regex.Replace()
when using a replacement delegate in theReplace
module to avoid an infinite recursion edge case (#624) - [Fix] Better handling of . (dot) character in
RedirectFrom
module (#620, #621, thanks @wozzo) - [Feature] Added a new default behavior for
Sitemap
to generate a document link if noSitemapItem
key is provided or usable (#622) - [Feature] Adds support for defining custom content types in the preview server
- [Feature] Added
IMetadata.GetMetadata()
to get a new metadata object with only the specified keys - [Feature] Adds an additional constructor to the
Execute
module to process the entire input set at once - [Feature] Adds ability to serialize selected metadata keys to a JSON object in
GenerateJson
module - [Feature] Adds ability to specify additional serializer settings for
GenerateJson
module - [Fix] Fixes bug with
GenerateJson
module not setting metadata key - [Refactoring] Removed the Wyam.Windows installer, it's been replaced by Chocolatey and eventually a .NET CLI global tool
Please see https://wyam.io/docs/usage/obtaining for important notes about downloading and installing.
v1.2.0
- [Feature] Locks in matching recipe and theme package versions (#587)
- [Refactoring] Some docs updates (#604, thanks @olevett)
- [Feature] Can add Markdown extension instances directly (#602, thanks @Silvenga)
- [Fix] Fixes adding multiple custom Markdown extensions (#601, thanks @Silvenga)
- [Fix] Fixes output corruption when using
--noclean
(#593, thanks @Silvenga) - [Feature] Added support for generating a Chocolatey package (#598, #95, thanks @phillipsj)
- [Fix] CSS cleanup for arrows in the docs theme
- [Feature] Docs recipe now ignores Razor pages from the theme if an equivalent Markdown page exists (#595)
- [Feature] Added a
Where()
method to theConcat
module - [Feature] Added
DocsKeys.ShowInSidebar
to hide pages from the sidebar in the docs recipe - [Fix] Ignore case when locating index files for the
Tree
module - [Feature] Added support for JSON content types to the embedded web server
- [Feature] Added sidebar header and footer overrides to docs theme
- [Refactoring] Updated MD5 hashes to SHA512 for FIPS compliance (#597, thanks @kakrofoon)
- [Feature] Enabled code signing for wyam.exe
- [Feature] Adds
DocsKeys.ApiPath
to allow changing the path where API docs are placed in the docs recipe
Please see https://wyam.io/docs/usage/obtaining for important notes about downloading and installing.
v1.1.0
- [Breaking Change][Refactoring] Removed the
Git
module since it's not fully SDK compatible - [Breaking Change][Refactoring] Removed the
Xslt2
module since it uses packages that are not cross platform or SDK compatible - [Refactoring] Removed the Windows installer. It will be replaced with a new servicing mechanism as the .NET Core port proceeds. In the meantime please download the .zip file.
- [Fix] Referenced assemblies are not loaded if a version was already directly loaded
- [Fix] Fix for excerpts in the BlogTemplate blog theme (#580, thanks @awulkan)
- [Fix] Fix for "Back to Posts" link in the BlogTemplate blog theme (#581, #583, thanks @jbrinkman)
- [Fix]
CodeAnalysis
and the docs recipe can now read SDK and .NET Core projects via Buildalyzer (#575) - [Refactoring] Updated Cake.Wyam to Cake 0.22.2 and targeting .NET Framework 4.6 and .NET Standard 1.6 (#579, #573, thanks @ProgrammerAL and @RLittlesII)
- [Fix] Fix for generated syntax from
CodeAnalysis
for more than one attribute within a bracket (#577, thanks @jonasdoerr) - [Refactoring] Converted most of the projects to the SDK (no impact on release artifacts, but important for contributors)
Please see https://wyam.io/docs/usage/obtaining for important notes about downloading and installing.
v1.0.0
- [Breaking Change][Refactoring] Removed all deprecated code including string-based document creation methods
- [Breaking Change][Refactoring] Renamed
Download.CacheResponse()
toDownload.CacheResponses()
- [Breaking Change][Refactoring] Renamed
RequestHeader
class for use with theDownload
module toRequestHeaders
- [Feature] Added support for custom headers to
RequestHeaders
for use withDownload
module - [Feature] New
YouTube
module for interacting with the YouTube API (#547, thanks @ghuntley) - [Feature] New Trophy theme for Blog recipe (#522, thanks @adamclifford)
- [Fix] Fixed a bug in Docs recipe when generating lowercase links
- [Fix]
NormalizedPath
no longer trims spaces (#566) - [Feature] New Stellar theme for Blog recipe (#563, thanks @arebee)
- [Feature] The compiled config script is now cached to disk as
config.wyam.dll
andconfig.wyam.hash
(prefixed with whatever the config file name is) (#557, thanks @Silvenga) - [Feature] New
Objects
module for populating metadata by reflecting on an arbitrary object (#539, thanks @deanebarker) - [Feature] New
Xml
module for populating metadata by reading elements from XML content (#539, thanks @deanebarker) - [Feature] New
Sql
module for populating metadata by reading data from a SQL server (#539, thanks @deanebarker) - [Feature] New
ReadDataModule
abstract base module for populating metadata from arbitrary data (#539, thanks @deanebarker) - [Fix] Several fixes related to generic types in
AnalyzeCSharp
module and Docs recipe (#494, #564) - [Fix] Excludes empty namespaces from
AnalyzeCSharp
module by default (#526) - [Feature] Updated globbing pattern in Blog and Docs recipes to include blog posts in subfolders (#560, thanks @archnaut)
- [Feature] If a module implements
IDisposable
it will now be disposed when the engine is - [Refactoring] Disabled data protection services in
Razor
module (#559, thanks @Silvenga) - [Fix] Additional inherit doc support for properties and events in
AnalyzeCSharp
module (#553) - [Fix] Fix for search index items when virtual directory is used (#554)
- [Fix] Normalizes culture in all the examples (#544)
- [Fix] Fixes HTML escaping in API search results in Docs theme (#552)
Please see https://wyam.io/docs/usage/obtaining for important notes about downloading and installing.
v0.18.6
- [Feature] Added flag
DocsKeys.ImplicitInheritDoc
to docs recipe to globally assumeinheritdoc
(#551) - [Feature] Added
AnalyzeCSharp.WithImplicitInheritDoc()
to assumeinheritdoc
for symbols without any XML comments (#551) - [Fix] Fixed a bug in the
AutoLink
module when containing node also has escaped HTML content (#550) - [Fix] Fixed a bug with
If
module when using aContextConfig
delegate, unmatched documents were not falling through. You may need to add.WithUnmatchedDocuments()
if you are using anIf
module with the incorrect behavior. - [Feature] Added
Keys.LinkLowercase
to always generate lowercase links (default is false) (#546) - [Fix] Fixed a bug when using
NoSidebar
in docs recipe (#549)