.

Author: zanaptak

CHANGELOG.md

@@ -1,9 +1,10 @@
-# Zanaptak.TypedCssClasses changelog
+# Changelog - Zanaptak.TypedCssClasses
 
-## x.x.x (unreleased)
+[![GitHub](https://img.shields.io/badge/-github-gray?logo=github)](https://github.com/zanaptak/TypedCssClasses) [![NuGet](https://img.shields.io/nuget/v/Zanaptak.TypedCssClasses?logo=nuget)](https://www.nuget.org/packages/Zanaptak.TypedCssClasses)
 
-- Add CSS Module support in Fable projects ([#11](https://github.com/zanaptak/TypedCssClasses/pull/11)) @alfonsogarciacaro
-    - See fableCssModule parameter
+## 1.0.0 (2021-07-30)
+
+- Add [`fableCssModule`](https://github.com/zanaptak/TypedCssClasses/blob/main/doc/configuration.md#fablecssmodule) parameter for CSS Module support in Fable projects ([#11](https://github.com/zanaptak/TypedCssClasses/pull/11)) @alfonsogarciacaro
 - Fix stale cache data when changing `naming` and `nameCollisions` parameters ([#12](https://github.com/zanaptak/TypedCssClasses/issues/12))
 
 ## 0.4.0 (2020-07-26)
@@ -18,17 +19,17 @@
 
 ## 0.3.0 (2020-07-14)
 
-- Add configurable external command capability for CSS preprocessing ([#4](https://github.com/zanaptak/TypedCssClasses/issues/4))
+- Add configurable [external command](https://github.com/zanaptak/TypedCssClasses/blob/main/doc/configuration.md#external-command-support-for-css-preprocessing) capability for CSS preprocessing ([#4](https://github.com/zanaptak/TypedCssClasses/issues/4))
 - Support environment variables in parameters
 - Support OS-specific values in parameters
-- Add log file option
+- Add [`logFile`](https://github.com/zanaptak/TypedCssClasses/blob/main/doc/configuration.md#logfile) option
 - Enable Source Link
 - __Breaking change__: Target .NET Standard 2.0 only, per Type Provider SDK guidance (may affect very old build chains)
-- __Breaking change__: The environment variable and OS-specific parameter support may affect existing parameter values if they use the same syntax. See the `osDelimiters` and `expandVariables` options to address this.
+- __Breaking change__: The environment variable and OS-specific parameter support may affect existing parameter values if they use the same syntax. See the [`osDelimiters`](https://github.com/zanaptak/TypedCssClasses/blob/main/doc/configuration.md#osdelimiters) and [`expandVariables`](https://github.com/zanaptak/TypedCssClasses/blob/main/doc/configuration.md#expandvariables) options to address this.
 
 ## 0.2.0 (2019-09-27)
 
-- Add `nameCollisions` parameter for handling duplicate property names ([#1](https://github.com/zanaptak/TypedCssClasses/issues/1))
+- Add [`nameCollisions`](https://github.com/zanaptak/TypedCssClasses/blob/main/doc/configuration.md#namecollisions) parameter for handling duplicate property names ([#1](https://github.com/zanaptak/TypedCssClasses/issues/1))
 
 ## 0.1.0 (2019-08-21)
 
@@ -37,7 +38,7 @@
 
 ## 0.0.3 (2019-08-10)
 
-- Add GetProperties method providing seq of generated properties
+- Add [`getProperties`](https://github.com/zanaptak/TypedCssClasses/blob/main/doc/configuration.md#getproperties) option providing seq of generated properties, useful for code generation
 - Add .NET Framework target
 
 ## 0.0.2 (2019-08-06)

README.md

@@ -1,4 +1,6 @@
-# Zanaptak.TypedCssClasses [![Nuget](https://img.shields.io/nuget/v/Zanaptak.TypedCssClasses)](https://www.nuget.org/packages/Zanaptak.TypedCssClasses/)
+# Zanaptak.TypedCssClasses
+
+[![GitHub](https://img.shields.io/badge/-github-gray?logo=github)](https://github.com/zanaptak/TypedCssClasses) [![NuGet](https://img.shields.io/nuget/v/Zanaptak.TypedCssClasses?logo=nuget)](https://www.nuget.org/packages/Zanaptak.TypedCssClasses)
 
 A CSS class type provider for F# web development.
 
@@ -67,9 +69,9 @@ div [ ClassName <| String.concat " " [
 
 Preconfigured sample projects to see it in action and use as a starting point:
 
-- [Fable Sass sample](https://github.com/zanaptak/TypedCssClasses/tree/master/sample/FableSass) - Demonstrates TypedCssClasses with Sass compilation in a Fable project.
+- [Fable Sass sample](https://github.com/zanaptak/TypedCssClasses/tree/main/sample/FableSass) - Demonstrates TypedCssClasses with Sass compilation in a Fable project.
 
-- [Fable Tailwind sample](https://github.com/zanaptak/TypedCssClasses/tree/master/sample/FableTailwind) - Demonstrates TypedCssClasses with Tailwind CSS in a Fable project.
+- [Fable Tailwind sample](https://github.com/zanaptak/TypedCssClasses/tree/main/sample/FableTailwind) - Demonstrates TypedCssClasses with Tailwind CSS in a Fable project.
 
 ## Getting started
 
@@ -92,9 +94,11 @@ type css = CssClasses<"https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bo
 let x = css.``display-1``
 ```
 
+It should work with any IDE that supports type providers. (Tested in Visual Studio Code with Ionide-fsharp extension on Windows and Linux, and in Visual Studio on Windows.)
+
 ## Configuration
 
-See the [configuration instructions](doc/configuration.md) for full details on configuration parameters to customize the behavior of the type provider.
+See the [configuration instructions](https://github.com/zanaptak/TypedCssClasses/blob/main/doc/configuration.md) for full details on configuration parameters to customize the behavior of the type provider.
 
 ## Notes
 
@@ -104,4 +108,4 @@ Web URLs are expected to use static CDN or otherwise unchanging content and are
 
 If using Fable 2.x, update fable-compiler to version 2.3.17 or later to avoid an issue with the type provider failing to resolve relative file paths.
 
-CSS `@import` rules are not processed internally by the type provider. If desired, they can be processed via external command; see the [TestWithFable test project](https://github.com/zanaptak/TypedCssClasses/tree/master/test/TestWithFable) for an example using [PostCSS](https://postcss.org/) with the [postcss-import](https://github.com/postcss/postcss-import) plugin.
+CSS `@import` rules are not processed internally by the type provider. If desired, they can be processed via external command; see the [TestWithFable test project](https://github.com/zanaptak/TypedCssClasses/tree/main/test/TestWithFable) for an example using [PostCSS](https://postcss.org/) with the [postcss-import](https://github.com/postcss/postcss-import) plugin.

doc/configuration.md

@@ -1,4 +1,6 @@
-# Zanaptak.TypedCssClasses configuration instructions
+# Configuration - Zanaptak.TypedCssClasses
+
+[![GitHub](https://img.shields.io/badge/-github-gray?logo=github)](https://github.com/zanaptak/TypedCssClasses) [![NuGet](https://img.shields.io/nuget/v/Zanaptak.TypedCssClasses?logo=nuget)](https://www.nuget.org/packages/Zanaptak.TypedCssClasses)
 
 ## Getting started
 
@@ -21,7 +23,7 @@ type css = CssClasses<"https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bo
 let x = css.``display-1``
 ```
 
-This capability should work with any IDE that supports type providers. (Tested on Visual Studio Code with Ionide-fsharp extension on Windows and Linux, and Visual Studio 2019 on Windows.)
+It should work with any IDE that supports type providers. (Tested in Visual Studio Code with Ionide-fsharp extension on Windows and Linux, and in Visual Studio on Windows.)
 
 ## External command support for CSS preprocessing
 
@@ -71,10 +73,6 @@ If the `source` parameter specifies a local file, the type provider will monitor
 
 If a `commandFile` is specified, any leading lines from the output of the command that exactly specify a local file path will also be watched.
 
-## CSS Module support for Fable
-
-In a Fable project, CSS modules can be used
-
 ## Parameters
 
 ### source

src/TypedCssClasses.sln

@@ -10,10 +10,16 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution Items", "Solution
 		..\.editorconfig = ..\.editorconfig
 		..\.gitattributes = ..\.gitattributes
 		..\.gitignore = ..\.gitignore
+		..\CHANGELOG.md = ..\CHANGELOG.md
 		..\invoke.build.ps1 = ..\invoke.build.ps1
 		..\README.md = ..\README.md
 	EndProjectSection
 EndProject
+Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "doc", "doc", "{149E8767-E720-444B-BC61-C64C8510D37A}"
+	ProjectSection(SolutionItems) = preProject
+		..\doc\configuration.md = ..\doc\configuration.md
+	EndProjectSection
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -31,6 +37,9 @@ Global
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
 	EndGlobalSection
+	GlobalSection(NestedProjects) = preSolution
+		{149E8767-E720-444B-BC61-C64C8510D37A} = {CF019DE1-D98F-40B5-A1D4-FC4BE9AC74B6}
+	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {5CDB4F14-36E1-489C-B4F3-E9E8B8E027F4}
 	EndGlobalSection