diff --git a/.github/workflows/modern-theme.yml b/.github/workflows/modern-theme.yml index 52703ef7f..b7ce69956 100644 --- a/.github/workflows/modern-theme.yml +++ b/.github/workflows/modern-theme.yml @@ -1,4 +1,4 @@ -name: Modern theme +name: Build and Test and Publish (main) on: workflow_dispatch diff --git a/Directory.Build.props b/Directory.Build.props index ca1214e3e..013df25cb 100644 --- a/Directory.Build.props +++ b/Directory.Build.props @@ -25,8 +25,14 @@ F# fsharp formatting markdown code fssnip literate programming https://github.com/fsprojects/FSharp.Formatting https://fsprojects.github.io/FSharp.Formatting - https://raw.githubusercontent.com/fsprojects/FSharp.Formatting/master/docs/files/img/logo.png + logo.png Apache-2.0 git + ../../RELEASE_NOTES.md + + + + + \ No newline at end of file diff --git a/Directory.Packages.props b/Directory.Packages.props index 3b3d56946..c31a53aa4 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -24,5 +24,6 @@ + \ No newline at end of file diff --git a/FSharp.Formatting.sln b/FSharp.Formatting.sln index 76b0b62a2..18bf78788 100644 --- a/FSharp.Formatting.sln +++ b/FSharp.Formatting.sln @@ -121,12 +121,10 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "leftside", "leftside", "{18 EndProject Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "content", "content", "{FAD5C374-4748-4A3D-A435-FFA425916F3A}" ProjectSection(SolutionItems) = preProject - docs\content\fsdocs-custom.css = docs\content\fsdocs-custom.css docs\content\fsdocs-default.css = docs\content\fsdocs-default.css docs\content\fsdocs-search.js = docs\content\fsdocs-search.js docs\content\fsdocs-tips.js = docs\content\fsdocs-tips.js - docs\content\navbar-fixed-left.css = docs\content\navbar-fixed-left.css - docs\content\navbar-fixed-right.css = docs\content\navbar-fixed-right.css + docs\content\fsdocs-theme-toggle.js = docs\content\fsdocs-theme-toggle.js EndProjectSection EndProject Global diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md index 64cd92009..a362c5e4f 100644 --- a/RELEASE_NOTES.md +++ b/RELEASE_NOTES.md @@ -1,225 +1,327 @@ -## 19.1.1 +# Changelog + +## [Unreleased] + +### Added +* Add more options to customize colors. + +### Removed +- `--fsdocs-theme-toggle-light-color` and `--fsdocs-theme-toggle-dark-color` are now deprecated. Use `--header-link-color` instead. +- `` + +## 20.0.0-alpha-012 - 2023-11-17 + +### Added +* Add more options to customize colors. + +## 20.0.0-alpha-011 - 2023-11-16 + +### Fixed +* Take `` into account during the project restore check. + +## 20.0.0-alpha-010 - 2023-11-15 + +### Fixed +* Update styling for blockquote. +* Update search documentation. +* Tweak dark theme colors. +* Loosen the header link search restriction. +* Improve custom theme icon. +* Correct fsdocs-menu-item-active-class value. +* Fix example of Right-Side navigation. + +### Changed +* Allow for more fine-grained styling control. + +## 20.0.0-alpha-009 - 2023-11-11 + +### Fixed +* Return original prop when no Directory.Build.props is used as fallback. + +## 20.0.0-alpha-008 - 2023-11-10 + +### Fixed +* Add dynamic `max-width` to tooltip. +* Overflow long namespace names in overview table. + +## 20.0.0-alpha-007 - 2023-11-10 + +### Fixed +* Smaller scrollbars on mobile devices + +### Added +* Use property values from the current `Directory.Build.props` file as fallback. [#865](https://github.com/fsprojects/FSharp.Formatting/issues/865) + +## 20.0.0-alpha-006 - 2023-11-09 + +### Added +* Revisited search using [fusejs](https://www.fusejs.io/) + +## 20.0.0-alpha-005 - 2023-11-09 + +### Changed +* Improve API doc styling. + +### Fixed +* Make mobile menu scrollable. + +## 20.0.0-alpha-004 - 2023-11-08 + +### Fixed +* Don't use font ligatures, the can confuse newcomers of F#. +* Replace `{{fsdocs-list-of-namespaces}}` with an empty string if no API docs are present. +* Improve default styling of `blockquote` +* Add some padding for level 3 and 4 headers in 'on this page' section. + +## 20.0.0-alpha-003 - 2023-11-06 + +### Changed +* default template style changes (`#fsdocs-page-menu` outside `main`, link around project name, overflow ellipsis for menu items) + +## 20.0.0-alpha-002 - 2023-11-03 + +### Fixed +* `{{root}}` is now available as substitution in `_body.html` and `_head.html`. + +## 20.0.0-alpha-001 - 2023-11-03 + +### Removed +* `FsDocsNavbarPosition` is no longer respected. Use CSS variables instead. See [docs](https://fsprojects.github.io/FSharp.Formatting/templates/leftside/styling.html). +* ⚠️ Search was completely removed and will be revisited in future versions. + +### Changed +* The default template was updated and is not compatible with previous versions. + +### Added +* Dark mode is available out of the box. +* `{{fsdocs-head-extra}}` can included additional html before the closing `` when `_head.html` exists. +* `{{fsdocs-body-extra}}` can included additional html before the closing `` when `_body.html` exists. +* MSBuild property `` can be used to configure the favicon. +* `active` class is added to the active menu item in `{{fsdocs-list-of-documents}}`. +If menu templating is used, `{{fsdocs-menu-header-active-class}}` and `{{fsdocs-menu-item-active-class}}` are avaiable. +* `{{fsdocs-page-content-list}}` contains an unordered list of the header (`h1` till `h4`) of the current page. (if available) + +## 19.1.1 - 2023-10-10 * Fix code rendering on firefox. [#851](https://github.com/fsprojects/FSharp.Formatting/pull/851) -## 19.1.0 +## 19.1.0 - 2023-09-15 * Only reload css file when changed. [#845](https://github.com/fsprojects/FSharp.Formatting/pull/845) * Add previous and next page url substitutions. [#846](https://github.com/fsprojects/FSharp.Formatting/pull/846) -## 19.0.0 +## 19.0.0 - 2023-08-22 * Update FCS to 43.7.400 -## 18.1.1 +## 18.1.1 - 2023-08-02 * Pass `--multiemit-` as default option for `FsiEvaluator`. -## 18.1.0 +## 18.1.0 - 2023-04-13 * Collapsible ApiDocs member info [#778](https://github.com/fsprojects/FSharp.Formatting/issues/778). The issue was fixed collaboratively in an [Amplifying F# session](https://amplifying-fsharp.github.io/) with a recording that can be found [here](https://amplifying-fsharp.github.io/sessions/2023/03/31/). -## 18.0.0 +## 18.0.0 - 2023-03-29 * Update FCS to 43.7.200 * Target `net6.0` for `fsdocs-tool` [#799](https://github.com/fsprojects/FSharp.Formatting/issues/799) -## 17.4.1 +## 17.4.1 - 2023-03-29 * Update ipynb output metadata [#809](https://github.com/fsprojects/FSharp.Formatting/issues/809) -## 17.4.0 +## 17.4.0 - 2023-03-09 * One FSI evaluator per docs file [#737](https://github.com/fsprojects/FSharp.Formatting/issues/737) -## 17.3.0 +## 17.3.0 - 2023-03-06 * Better test project detection [#800](https://github.com/fsprojects/FSharp.Formatting/issues/800) -## 17.2.3 +## 17.2.3 - 2023-02-21 * Fix external docs link [#794](https://github.com/fsprojects/FSharp.Formatting/issues/794) -## 17.2.2 +## 17.2.2 - 2023-01-16 * Improvement for `` [#789](https://github.com/fsprojects/FSharp.Formatting/issues/789) -## 17.2.1 +## 17.2.1 - 2023-01-14 * Fix support for `` [#786](https://github.com/fsprojects/FSharp.Formatting/issues/786) -## 17.2.0 +## 17.2.0 - 2022-12-28 * Resolve markdown links in raw html [#769](https://github.com/fsprojects/FSharp.Formatting/issues/769) -## 17.1.0 +## 17.1.0 - 2022-11-22 * [Add syntax highlighting to API docs](https://github.com/fsprojects/FSharp.Formatting/pull/780) -## 17.0.0 +## 17.0.0 - 2022-11-17 * Update to .NET 7.0.100 -## 16.1.1 +## 16.1.1 - 2022-09-07 * [Fix arguments naming and escape operator name in usageHtml](https://github.com/fsprojects/FSharp.Formatting/pull/765/) -## 16.1.0 +## 16.1.0 - 2022-08-30 * Update to .NET 6.0.400 * Update to Ionide.ProjInfo 0.60 -## 16.0.4 +## 16.0.4 - 2022-08-30 * [Fix indexers in output](https://github.com/fsprojects/FSharp.Formatting/pull/767) -## 16.0.3 +## 16.0.3 - 2022-08-30 * [Fix link translation when using relative input path](https://github.com/fsprojects/FSharp.Formatting/issues/764) -## 16.0.2 +## 16.0.2 - 2022-08-23 * [Improves markdown emphasis parsing.](https://github.com/fsprojects/FSharp.Formatting/pull/763) -## 16.0.1 - -* Custom templaying for menus +## 16.0.1 - 2023-08-16 +* Custom templating for menus -## 15.0.3 +## 15.0.3 - 2023-08-15 * Fixes Markdown parser gets multiple-underscores-inside-italics wrong [#389](https://github.com/fsprojects/FSharp.Formatting/issues/389) -## 15.0.2 +## 15.0.2 - 2023-08-05 * Trim the `--fscoptions` before passing them as `otherflags`. ([comment #616](https://github.com/fsprojects/FSharp.Formatting/issues/616#issuecomment-1200877765)) -## 15.0.1 +## 15.0.1 - 2023-07-01 * fix https://github.com/fsprojects/FSharp.Formatting/issues/749 -## 15.0.0 +## 15.0.0 - 2022-03-20 * Update to .NET 6 -## 14.0.1 +## 14.0.1 - 2021-11-11 * Fixes 703, 700 - `--strict` is now considerably stricter, and more diagnostics being shown -## 14.0.0 +## 14.0.0 - 2021-11-10 * Fix [Getting ReturnType from ApiDocMember without Html already embedded](https://github.com/fsprojects/FSharp.Formatting/issues/708) -## 13.0.1 +## 13.0.1 - 2021-11-10 * Skip the output folder when processing -## 13.0.0 +## 13.0.0 - 2021-11-10 * Remove unused TransformAndOutputDocument from API * Fixes Can't yet format InlineHtmlBlock #723 * Fixes `` blocks are emitting `
` blocks with escapes no longer escaped #712
 
-## 12.0.2
+## 12.0.2 - 2021-11-10
 
 * Remove front-matter output from notebooks
 
-## 12.0.1
+## 12.0.1 - 2021-11-10
 
 * Improve package description
 
-## 12.0.0
+## 12.0.0 - 2021-11-07
 
 * [Allow input-->output link translation](https://github.com/fsprojects/FSharp.Formatting/pull/718)
 
-## 11.5.1
+## 11.5.1 - 2021-10-30
 
 * [Allow user-set ids for xmldoc example nodes](https://github.com/fsprojects/FSharp.Formatting/pull/704)
 
-## 11.5.0
+## 11.5.0 - 2021-10-30
 
 * [Remove MSBuild assemblies from library nugets](https://github.com/fsprojects/FSharp.Formatting/pull/715)
 
-## 11.4.4
+## 11.4.4 - 2021-10-11
 
 * [Websocket CPU efficiency improvements](https://github.com/fsprojects/FSharp.Formatting/pull/711)
 
-## 11.4.3
+## 11.4.3 - 2021-08-17
 
 * Style blockquotes
 
-## 11.4.2
+## 11.4.2 - 2021-07-29
 
 * [Download links broken](https://github.com/fsprojects/FSharp.Formatting/issues/696)
 * [Duplicating HTML tags for FSX and IPYNB output](https://github.com/fsprojects/FSharp.Formatting/issues/695)
 
-## 11.4.1
+## 11.4.1 - 2021-07-23
 
 * [Fixed navbar scrolling](https://github.com/fsprojects/FSharp.Formatting/issues/672#issuecomment-885532640)
 
-## 11.4.0
+## 11.4.0 - 2021-07-22
 
 * [Fixed some CSS](https://github.com/fsprojects/FSharp.Formatting/pull/688/)
 
-## 11.3.0
+## 11.3.0 - 2021-07-22
 
 * [Bump to FSharp.Compiler.Service 40.0](https://github.com/fsprojects/FSharp.Formatting/pull/682)
 * [Fix bottom margin in default CSS](https://github.com/fsprojects/FSharp.Formatting/pull/687)
 * [Improve github and signature links](https://github.com/fsprojects/FSharp.Formatting/pull/681)
 * [Fix typo in location for custom CSS](https://github.com/fsprojects/FSharp.Formatting/pull/684)
 
-## 11.2.0
+## 11.2.0 - 2021-05-17
 
 * scrollable navbar #677 by nhirschey 
 * Show field type for record fields #674
 * Add --ignoreprojects flag  #676 by chengh42 
 
-## 11.1.0
+## 11.1.0 - 2021-04-15
 * Add frontmatter, category, categoryindex, index, title
 
-## 11.0.4
+## 11.0.4 - 2021-04-15
 * testing package publish
 
-## 11.0.3
+## 11.0.3 - 2021-04-14
 * testing package publish
 
-## 11.0.2
+## 11.0.2 - 2021-04-14
 * add favicon.ico to template and use F# logo as default favicon for generated sites
 
-## 11.0.1
+## 11.0.1 - 2021-04-14
 * update to Ionide.ProjInfo
 * use computed args for references in API doc generation
 * Fix #616
 * Fix #662
 * Fix #646
 
-## 10.1.1
+## 10.1.1 - 2021-04-13
 * Switch to cleaner default styling based on DiffSharp styles
 * Change `fsdocs-menu` to `fsdocs-nav`
 
-## 10.0.8
+## 10.0.8 - 2021-04-13
 * Add cref copy buttons by default
 
-## 10.0.7
+## 10.0.7 - 2021-04-13
 * Fix more formatting and switch to `fsdocs-member-usage` instead of `fsdocs-member-name`
 
-## 10.0.2
+## 10.0.2 - 2021-04-13
 * Permit `cref:T:System.Console` code references in markdown content
 
-## 10.0.1
+## 10.0.1 - 2021-04-12
 * Apply substitutions to content
 * Add `fsdocs-source-filename` and `fsdocs-source-basename` substitutions
 
-## 9.0.4
+## 9.0.4 - 2021-03-24
 * Trim spaces from examples (TrimEnd only)
 
-## 9.0.3
+## 9.0.3 - 2021-03-24
 * Trim spaces from examples
 
-## 9.0.1
+## 9.0.1 - 2021-02-11
 * Proper fix for elide multi-language docs from navigation and site search index
 
-## 9.0.0
+## 9.0.0 - 2021-02-11
 * Rename --property flag to --properties
 * Elide multi-language docs from navigation and site search index
 
-## 8.0.1
+## 8.0.1 - 2021-01-21
 * [Prevent CLI parameters from being discarded](https://github.com/fsprojects/FSharp.Formatting/pull/634)
 * [Update Dockerfile and NuGet.config for binder](https://github.com/fsprojects/FSharp.Formatting/pull/636)
 
-## 8.0.0
+## 8.0.0 - 2021-01-14
 * [update FCS, allow fsdocs to roll forward to net5.0](https://github.com/fsprojects/FSharp.Formatting/pull/621)
 * [Refactor the templating engine and the command tool cache](https://github.com/fsprojects/FSharp.Formatting/pull/615)
 * [Refactor the project cracker](https://github.com/fsprojects/FSharp.Formatting/pull/618)
@@ -228,14 +330,14 @@
 * Add more complete info on how to upgrade
 * [CommandTool: add hot reload to the watch command](https://github.com/fsprojects/FSharp.Formatting/pull/629)
 
-## 7.2.9
+## 7.2.9 - 2020-09-22
 
 * Document how to do math in XML comments
 * Add --strict flag to fsdocs for stricter checking
 * Add --property flag to fsdocs to pass properties to dotnet msbuild
 * Better diangostics and logging for fsdocs
 
-## 7.2.8
+## 7.2.8 - 2020-09-09
 
 * [ApiDocs: examples not showing for types and modules](https://github.com/fsprojects/FSharp.Formatting/issues/599)
 
@@ -243,504 +345,413 @@
 
 * Remove untyped Sections from ApiDocComment since individual supported sections are now available
 
-## 7.2.7
+## 7.2.7 - 2020-09-09
 
 * [ApiDocs: cref to members are not resolving to best possible link](https://github.com/fsprojects/FSharp.Formatting/issues/598)
 
 * [ApiDocs: namespace docs are showing in module/type summaries as well](https://github.com/fsprojects/FSharp.Formatting/issues/597)
 
-## 7.2.6
+## 7.2.6 - 2020-08-07
+
+* In ApiDocsModel, separate out the parameter, summary, remarks sections etc.
+
+* In ApiDocsModel, integrate the parameter types with the parameter docs (when using XML docs)
+
+* In HTML generation for API docs, locate the github link top right 
+
+* In ApiDocsModel.Generate, optionally give warnings when XML doc is missing or parameter names are incorrect. Activate using 
+
+* In ApiDocsModel, change "Parameters" to "Substitutions"
+
+* Fix formatting of (most) custom operators
+
+* Fix formatting of op_XYZ binary and unary operators 
+
+## 7.2.5 - 2020-08-06
+
+* change `...` to ` ...  `
+
+* change `3` to `...`
+
+## 7.2.4 - 2020-08-06
 
-- In ApiDocsModel, separate out the parameter, summary, remarks sections etc.
+* support `...`
 
-- In ApiDocsModel, integrate the parameter types with the parameter docs (when using XML docs)
+* support `...`
 
-- In HTML generation for API docs, locate the github link top right 
+* support `...`
 
-- In ApiDocsModel.Generate, optionally give warnings when XML doc is missing or parameter names are incorrect. Activate using 
+* support `...`
 
-- In ApiDocsModel, change "Parameters" to "Substitutions"
+* support ``
 
-- Fix formatting of (most) custom operators
+* allow  `` in XML doc comments
 
-- Fix formatting of op_XYZ binary and unary operators 
+* allow  `` in XML doc comments
 
+* document XML doc things supported
 
-## 7.2.5
+## 7.2.2 - 2020-08-05
 
-- change `...` to ` ...  `
+* instruct about settings
 
-- change `3` to `...`
+## 7.2.1 - 2020-08-05
 
-## 7.2.4
+* fix images in nuget
 
-- support `...`
+## 7.2.0 - 2020-08-05
 
-- support `...`
+* include templates
 
-- support `...`
+## 7.1.8 - 2020-08-05
 
-- support `...`
+* bump version
 
-- support ``
+## 7.1.6 - 2020-08-04
 
-- allow  `` in XML doc comments
+* bump version
 
-- allow  `` in XML doc comments
+## 7.1.5 - 2020-08-04
 
-- document XML doc things supported
+* fix navbar position option fixed-left
 
-## 7.2.2
+## 7.1.4 - 2020-08-04
 
-- instruct about settings
+* fixed property computation 
 
-## 7.2.1
+## 7.1.3 - 2020-08-04
 
-- fix images in nuget
+* fixed typo for `LICENCE.md`
 
-## 7.2.0
+* all classes to have `fsdocs-` prefix
 
-- include templates
+## 7.1.2 - 2020-08-04
 
-## 7.1.8
+* fixed all classes to have `fsdocs-` prefix
 
-- bump version
+* added documentation on styling
 
-## 7.1.6
+## 7.1.1 - 2020-08-04
 
-- bump version
+* fixed root
 
-## 7.1.5
+## 7.1.0 - 2020-08-04
 
-- fix navbar position option fixed-left
+* add text content of markdown and scripts to generated search index
 
-## 7.1.4
+* overhaul the substitution names used by FSharp.Formatting and expected in the template. The table is in the docs and below
 
-- fixed property computation 
+* generate {{fsdocs-list-of-documents}} substitution and use it in both API docs and content
 
-## 7.1.3
+* generate {{fsdocs-list-of-namespaces}} substitution and use it in both API docs and content
 
-- fixed typo for `LICENCE.md`
+* fix link model so {{root}} is always respected
 
-- all classes to have `fsdocs-` prefix
+* Add `qualify` parameter that asks to qualify all names by the collection name e.g. FSharp.Core
 
-## 7.1.2
+* Respect per-project settings, e.g. if one nuget package has a different set of authors or home page to another
 
-- fixed all classes to have `fsdocs-` prefix
+* Add documentation about styling
 
-- added documentation on styling
+* Allow fixed-left and fixed-right positions for the navbar
 
-## 7.1.1
+* Add `{{fsdocs-logo-link}}` parameter to default template
 
-- fixed root
+* Add `{{fsdocs-logo-link}}` parameter to default template
 
-## 7.1.0
+* generate HTML giving hyperlinks for types with cross-links
 
-- add text content of markdown and scripts to generated search index
+* switch to left bootstrap nav bar in template for a table of contents
 
-- overhaul the substitution names used by FSharp.Formatting and expected in the template. The table is in the docs and below
+* improve sizings
 
-- generate {{fsdocs-list-of-documents}} substitution and use it in both API docs and content
+* move to one copy of template in docs/_template.html 
 
-- generate {{fsdocs-list-of-namespaces}} substitution and use it in both API docs and content
+* ApiDocsTypeDefinition and ApiDocsModule merged to ApiDocsEntity
 
-- fix link model so {{root}} is always respected
+* Default template now expects logo in img/logo.png
 
-- Add `qualify` parameter that asks to qualify all names by the collection name e.g. FSharp.Core
+* Improvements in default HTML generation
 
-- Respect per-project settings, e.g. if one nuget package has a different set of authors or home page to another
+* ApiDocComment.Blurb renamed to ApiDocComment.Summary and only populated with summary text for things read from XML
 
-- Add documentation about styling
+* simplify tool instructions
 
-- Allow fixed-left and fixed-right positions for the navbar
+* add info about upgrading
 
-- Add `{{fsdocs-logo-link}}` parameter to default template
+## 6.1.0 - 2020-07-21
+* fix mistake in laying down `extras` directory 
 
-- Add `{{fsdocs-logo-link}}` parameter to default template
+## 6.0.9 - 2020-07-21
+* put extra content in `extras` directory in nuget package and include Dockerfile and NuGet.config
 
-- generate HTML giving hyperlinks for types with cross-links
+## 6.0.8 - 2020-07-21
+* show extended type in generated docs for extension members
+* include fsdocs-styles.css, fsdocs-search.js, fsdocs-tips.js in built site 'content' directory by default
+* use default template from nuget package by default
 
-- switch to left bootstrap nav bar in template for a table of contents
+## 6.0.7 - 2020-07-20
+* fix formatting of generic parameters so they don't show inference variables for members
 
-- improve sizings
+## 6.0.6 - 2020-07-20
+* fix default styling
 
-- move to one copy of template in docs/_template.html 
+## 6.0.5 - 2020-07-20
+* improve display in FSharp.Formatting API docs and add more information
 
-- ApiDocsTypeDefinition and ApiDocsModule merged to ApiDocsEntity
+## 6.0.4 - 2020-07-20
+* Watch defaults to `tmp/watch`
 
-- Default template now expects logo in img/logo.png
+## 6.0.3 - 2020-07-20
+* Add `(*** include-fsi-output **)`
+* Add `(*** include-fsi-merged-output **)`
+* Add server to `dotnet watch` and by default switch to local host
+* Always inject `fsi.AddPrinter`, `fsi.AddHtmlPrinter` etc. into the programming model for literate scripts
 
-- Improvements in default HTML generation
+## 6.0.2 - 2020-07-19
 
-- ApiDocComment.Blurb renamed to ApiDocComment.Summary and only populated with summary text for things read from XML
+* Remove the `api` command from the command line tool (`build` generalises it)
+* Add missing search.js
 
-- simplify tool instructions
+## 6.0.1 - 2020-07-19
 
-- add info about upgrading
+* build the Lunr `index.json` from every execution of `fsdocs build`
+* Make the search index entries available as part of the ApiDocs model
+* Add search box to generated docs
+* Add `ApiDocs` prefix to all types in `ApiDocsModel`
+* Remove `Details` from `ApiDocsModel`
 
-## 6.1.0
-- fix mistake in laying down `extras` directory 
+## 5.0.5 - 2020-07-14
 
-## 6.0.9
-- put extra content in `extras` directory in nuget package and include Dockerfile and NuGet.config
+* Correct behaviour of '--clean'
 
-## 6.0.8
-- show extended type in generated docs for extension members
-- include fsdocs-styles.css, fsdocs-search.js, fsdocs-tips.js in built site 'content' directory by default
-- use default template from nuget package by default
+## 5.0.4 - 2020-07-14
 
-## 6.0.7
-- fix formatting of generic parameters so they don't show inference variables for members
+* Fix emit of odd character in latex output
 
-## 6.0.6
-- fix default styling
+## 5.0.3 - 2020-07-14
 
-## 6.0.5
-- improve display in FSharp.Formatting API docs and add more information
+* Paket update and remove workaround code
+* add '--clean' to fsdocs 
 
-## 6.0.4
-- Watch defaults to `tmp/watch`
+## 5.0.2 - 2020-07-14
+* Update to FCS v36.0
+* Add .ipynb output option for documents
+* Add .fsx output option for documents
+* Literate.WriteHtml --> Literate.ToHtml/Literate.WriteHtml overloads
+* MetadataFormat.Generate --> ApiDocs.GenerateHtml/ApiDocs.GenerateModel overloads
+* Fix Literate.* to do approximate (non-razor) templating/  
+* Remove Razor support
+* HTML templates now use `{{prop-name}}`
+* FSharp.CodeFormat --> FSharp.Formatting.CodeFormat
+* FSharp.Markdown --> FSharp.Formatting.Markdown
+* FSharp.Literate --> FSharp.Formatting.Literate and FSharp.Formatting.Literate.Evaluation
+* FSharp.MetadataFormat --> FSharp.Formatting.ApiDocs
+* FSharp.ApiDocs uses HTML substitution for templating, no Razor
+* Add "include-it" and "include-output" with implied reference to the immediately preceding snippet
+* For command line tool
+Rename fsformatting to fsdocs
+Update command line parser
+"fsformatting literate process-directory" --> "fsdocs convert"
+"fsformatting metadata-format generate" --> "fsdocs api"
+"--dllFiles" --> "--dlls"
+"--outDir" --> "--output"
+"--outputDirectory" --> "--output"
+"--output" is optional (defaults to 'output')
+"--inputDirectory" --> "--input"
+Add --nonpublic
+Add --xmlComments
+Automatically populate metadata from project settings.
+* Add `fsdocs build` command to the documentation generator that has lots of sensible defaults.
 
-## 6.0.3
-- Add `(*** include-fsi-output **)`
-- Add `(*** include-fsi-merged-output **)`
-- Add server to `dotnet watch` and by default switch to local host
-- Always inject `fsi.AddPrinter`, `fsi.AddHtmlPrinter` etc. into the programming model for literate scripts
+## 4.1.0 - 2020-06-01
+* Support preview F# language features.
+* Add support for customizing assigned CSS class.
 
-## 6.0.2
+## 4.0.1 - 2020-05-12
+* Add .NET Core support for all libraries.
+* Update to FSCS v35.0.
+* Add helpers for CustomOperationAttribute.
 
-- Remove the `api` command from the command line tool (`build` generalises it)
-- Add missing search.js
+## 4.0.0-rc2 - 2020-04-24
+* Update to FSCS v34.1.
 
-## 6.0.1
+## 4.0.0-rc2 - 2020-04-24
+* Update to FSCS v34.
 
-- build the Lunr `index.json` from every execution of `fsdocs build`
-- Make the search index entries available as part of the ApiDocs model
-- Add search box to generated docs
-- Add `ApiDocs` prefix to all types in `ApiDocsModel`
-- Remove `Details` from `ApiDocsModel`
+## 4.0.0-rc2 - 2020-04-24
+* Fix packaging issues.
 
-## 5.0.5
+## 4.0.0-rc2 - 2020-04-24
+* Add .NET Core support for all libraries.
+* Update to latest FSharp.Compiler.Service
+
+## 3.1.0 - 2019-04-12
+* remove beta tag since it is already widely used
+
+## 3.0.0-beta01 - 2016-08-01
+* Update to latest FSharp.Compiler.Service
+* No longer filter FSHarp.Core based on optdata/sigdata (it is now always bundled)
+
+## 3.0.0-beta01 - 2016-08-01
+* FSharp.Formatting.Literate for netstandard2.0
+
+## 3.0.0-beta01 - 2016-08-01
+* Fix usage formatting - https://github.com/fsprojects/FSharp.Formatting/issues/472
+
+## 3.0.0-beta01 - 2016-08-01
+* Added support for attributes on modules, types and members
+* Updated razor templates to show attributes and added a warning for obsolete API
+
+## 3.0.0-beta01 - 2016-08-01
+* Upgrade FSharp.Compiler.Service to be compatible with FAKE 5
+
+## 3.0.0-beta01 - 2016-08-01
+* Fix some links on the website - https://github.com/fsprojects/FSharp.Formatting/pull/458
+* Another link on the website - https://github.com/fsprojects/FSharp.Formatting/pull/454
+* Support highlighting for paket.dependencies `storage` keyword - https://github.com/fsprojects/FSharp.Formatting/pull/451
+* In order to upgrade follow instructions at https://fsprojects.github.io/FSharp.Formatting/upgrade_from_v2_to_v3.html
+
+## 3.0.0-beta01 - 2016-08-01
+* Improve Stacktrace on Script file processing
+
+## 3.0.0-beta01 - 2016-08-01
+* Fix System.ValueType dep.
+
+## 3.0.0-beta01 - 2016-08-01
+* Include razor component.
+
+## 3.0.0-beta01 - 2016-08-01
+* Always generate anchors when using command line tool.
+
+## 3.0.0-beta01 - 2016-08-01
+* Don't hide errors in fsformatting tool (Literate).
+* Improve error message by using inner exceptions.
+
+## 3.0.0-beta01 - 2016-08-01
+* Don't hide errors in fsformatting tool.
+
+## 3.0.0-beta01 - 2016-08-01
+* MarkdownSpan and MarkdownParagraph now use named DUs
+* Add range to MarkdownParagraph and MarkdownSpan (https://github.com/fsprojects/FSharp.Formatting/pull/411)
+* FSharp.Formatting no longer has a strong dependency on Razor (https://github.com/fsprojects/FSharp.Formatting/pull/425)
+* FSharp.Formatting no longer depends on VFPT.Core (https://github.com/fsprojects/FSharp.Formatting/pull/432)
+* Add beta packages to AppVeyor feed.
+* Update FSharp.Compiler.Service component.
+
+## 2.14.4 - 2016-06-02
+* Use `#I __SOURCE_DIRECTORY__` in the loads script (more reliable)
+
+## 2.14.3 - 2016-05-26
+* Fixes issues with comments and keywords in Paket highlighter (#408)
+* Fix tooltip flickering in CSS (#406)
+* End blockquote on a line with an empty blockquote (fix #355) (#400)
+
+## 2.14.2 - 2016-04-06
+* Add code to parse table rows correctly (#394)
+* Also fixes (#388) Markdown parser doesn't recognize inline code `x | y` inside table cell
+
+## 2.14.1 - 2016-04-05
+* Temporarily pin FSharp.Compiler.Service (#395)
+* Cache is new keyword in Paket (#392)
+
+## 2.13.6 - 2016-02-29
+* Added TypeScript to the CSharpFormat project (#386)
+
+## 2.13.5 - 2016-01-25
+* Fixes issues in PaketFormat (#381) - colorize HTTP and file prefix
+* Reliable getTypeLink (#380) - avoid crashes
 
-- Correct behaviour of '--clean'
+## 2.13.4 - 2016-01-20
+* Colors paket keywords (#379)
 
-## 5.0.4
+## 2.13.3 - 2016-01-18
+* Adds PaketFormat to not color URLs as comments in Paket files (#349)
 
-- Fix emit of odd character in latex output
+## 2.13.2 - 2016-01-12
+* Improve the load script to fix FsLab issue (https://github.com/fslaborg/FsLab/issues/98)
 
-## 5.0.3
+## 2.13.1 - 2016-01-12
+* Make logging to file optional using environment variable
 
-- Paket update and remove workaround code
-- add '--clean' to fsdocs 
+## 2.13.0 - 2015-12-29
+* Be compatible with the common-mark spec for 'Fenced code blocks' and 'Indented code blocks'.
+See https://github.com/fsprojects/FSharp.Formatting/pull/343.
+Please follow-up by adding support for more sections of the spec!
+Just add the section to https://github.com/fsprojects/FSharp.Formatting/blob/master/tests/FSharp.Markdown.Tests/CommonMarkSpecTest.fs#L20
+and fix the newly enabled tests.
+* Add CompiledName to members with F# specific naming (https://github.com/fsprojects/FSharp.Formatting/pull/372)
 
-## 5.0.2
-- Update to FCS v36.0
-- Add .ipynb output option for documents
-- Add .fsx output option for documents
-- Literate.WriteHtml --> Literate.ToHtml/Literate.WriteHtml overloads
-- MetadataFormat.Generate --> ApiDocs.GenerateHtml/ApiDocs.GenerateModel overloads
-- Fix Literate.* to do approximate (non-razor) templating/  
-- Remove Razor support
-- HTML templates now use `{{prop-name}}`
-- FSharp.CodeFormat --> FSharp.Formatting.CodeFormat
-- FSharp.Markdown --> FSharp.Formatting.Markdown
-- FSharp.Literate --> FSharp.Formatting.Literate and FSharp.Formatting.Literate.Evaluation
-- FSharp.MetadataFormat --> FSharp.Formatting.ApiDocs
-- FSharp.ApiDocs uses HTML substitution for templating, no Razor
-- Add "include-it" and "include-output" with implied reference to the immediately preceding snippet
-- For command line tool
-        Rename fsformatting to fsdocs
-        Update command line parser
-        "fsformatting literate process-directory" --> "fsdocs convert"
-        "fsformatting metadata-format generate" --> "fsdocs api"
-        "--dllFiles" --> "--dlls"
-        "--outDir" --> "--output"
-        "--outputDirectory" --> "--output"
-        "--output" is optional (defaults to 'output')
-        "--inputDirectory" --> "--input"
-        Add --nonpublic
-        Add --xmlComments
-        Automatically populate metadata from project settings.
-- Add `fsdocs build` command to the documentation generator that has lots of sensible defaults.
-
-## 4.1.0
-- Support preview F# language features.
-- Add support for customizing assigned CSS class.
-
-## 4.0.1
-- Add .NET Core support for all libraries.
-- Update to FSCS v35.0.
-- Add helpers for CustomOperationAttribute.
-
-## 4.0.0-alpha04
-- Update to FSCS v34.1.
-
-## 4.0.0-alpha03
-- Update to FSCS v34.
-
-## 4.0.0-alpha02
-- Fix packaging issues.
-
-## 4.0.0-alpha01
-- Add .NET Core support for all libraries.
-- Update to latest FSharp.Compiler.Service
-
-## 3.1.0
-- remove beta tag since it is already widely used
-
-## 3.0.0-beta14 
- - Update to latest FSharp.Compiler.Service
- - No longer filter FSHarp.Core based on optdata/sigdata (it is now always bundled)
- 
-## 3.0.0-beta13 
- - FSharp.Formatting.Literate for netstandard2.0
-
-## 3.0.0-beta12 (29, July, 2018)
- - Fix usage formatting - https://github.com/fsprojects/FSharp.Formatting/issues/472
-
-## 3.0.0-beta11 (06, May, 2018)
- - Added support for attributes on modules, types and members
- - Updated razor templates to show attributes and added a warning for obsolete API
-
-## 3.0.0-beta10 (08, April, 2018)
- - Upgrade FSharp.Compiler.Service to be compatible with FAKE 5
-
-## 3.0.0-beta09 (04, February, 2018
- - Fix some links on the website - https://github.com/fsprojects/FSharp.Formatting/pull/458
- - Another link on the website - https://github.com/fsprojects/FSharp.Formatting/pull/454
- - Support highlighting for paket.dependencies `storage` keyword - https://github.com/fsprojects/FSharp.Formatting/pull/451
- - In order to upgrade follow instructions at https://fsprojects.github.io/FSharp.Formatting/upgrade_from_v2_to_v3.html
-
-## 3.0.0-beta08 (03 December, 2017)
- - Improve Stacktrace on Script file processing
- 
-## 3.0.0-beta07 (07 August, 2017)
- - Fix System.ValueType dep.
- 
-## 3.0.0-beta06 (16 June, 2017)
- - Include razor component.
- 
-## 3.0.0-beta05 (11 June, 2017)
- - Always generate anchors when using command line tool.
- 
-## 3.0.0-beta04 (28 May, 2017)
- - Don't hide errors in fsformatting tool (Literate).
- - Improve error message by using inner exceptions.
-
-## 3.0.0-beta03 (27 May, 2017)
- - Don't hide errors in fsformatting tool.
-
-## 3.0.0-beta02 (26 May, 2017)
- - MarkdownSpan and MarkdownParagraph now use named DUs
- - Add range to MarkdownParagraph and MarkdownSpan (https://github.com/fsprojects/FSharp.Formatting/pull/411)
- - FSharp.Formatting no longer has a strong dependency on Razor (https://github.com/fsprojects/FSharp.Formatting/pull/425)
- - FSharp.Formatting no longer depends on VFPT.Core (https://github.com/fsprojects/FSharp.Formatting/pull/432)
- - Add beta packages to AppVeyor feed.
- - Update FSharp.Compiler.Service component.
-
-## 2.14.4 (3 June, 2016)
- - Use `#I __SOURCE_DIRECTORY__` in the loads script (more reliable)
-
-## 2.14.3 (26 May, 2016)
- - Fixes issues with comments and keywords in Paket highlighter (#408)
- - Fix tooltip flickering in CSS (#406)
- - End blockquote on a line with an empty blockquote (fix #355) (#400)
-
-## 2.14.2 (6 April, 2016)
- - Add code to parse table rows correctly (#394)
- - Also fixes (#388) Markdown parser doesn't recognize inline code `x | y` inside table cell
-
-## 2.14.1 (5 April, 2016)
- - Temporarily pin FSharp.Compiler.Service (#395)
- - Cache is new keyword in Paket (#392)
-
-## 2.13.6 (29 February, 2016)
- - Added TypeScript to the CSharpFormat project (#386)
-
-## 2.13.5 (25 January, 2016)
- - Fixes issues in PaketFormat (#381) - colorize HTTP and file prefix
- - Reliable getTypeLink (#380) - avoid crashes
-
-## 2.13.4 (20 January, 2016)
- - Colors paket keywords (#379)
-
-## 2.13.3 (18 January, 2016)
- - Adds PaketFormat to not color URLs as comments in Paket files (#349)
-
-## 2.13.2 (12 January, 2016)
- - Improve the load script to fix FsLab issue (https://github.com/fslaborg/FsLab/issues/98)
-
-## 2.13.1 (12 January, 2016)
- - Make logging to file optional using environment variable
-
-## 2.13.0 (30 December, 2015)
- - Be compatible with the common-mark spec for 'Fenced code blocks' and 'Indented code blocks'.
-   See https://github.com/fsprojects/FSharp.Formatting/pull/343.
-   Please follow-up by adding support for more sections of the spec!
-   Just add the section to https://github.com/fsprojects/FSharp.Formatting/blob/master/tests/FSharp.Markdown.Tests/CommonMarkSpecTest.fs#L20
-   and fix the newly enabled tests.
- - Add CompiledName to members with F# specific naming (https://github.com/fsprojects/FSharp.Formatting/pull/372)
-
-## 2.12.1 (24 December, 2015)
- - update dependencies
- - Upgrade the CommandTool to F# 4 and bundle FSharp.Core with sigdata and optdata.
- - Fix crash when a fenced code block starts with an empty line (https://github.com/fsprojects/FSharp.Formatting/pull/361)
- - Support for all known xml elements (https://github.com/fsprojects/FSharp.Formatting/pull/331)
-
-## 2.12.0 (18 October, 2015)
- - Update dependencies to be compatible with FSharp.Compiler.Service >=1.4.0.3
-
-## 2.11.1-alpha1 (14 October, 2015)
- - Adds methods for cross-type links #330 (https://github.com/fsprojects/FSharp.Formatting/pull/330)
-
-## 2.11.0 (28 September, 2015)
- - Fix https://github.com/fsprojects/FSharp.Formatting/issues/271
- - Don't fail as long as we can recover / continue.
- - Fix https://github.com/fsprojects/FSharp.Formatting/issues/201
-
-## 2.10.3 (12 September, 2015)
- - Require compatible F# Compiler Service in Nuspec (fix #337)
-
-## 2.10.2 (12 September, 2015)
- - Fix load script (wrap logging setup in try catch properly)
-
-## 2.10.1 (12 September, 2015)
- - paket update && fix compilation (#338)
- - Wrap logging setup in try catch
-
-## 2.10.0 (26 July, 2015)
- - Add detailed logging and new FSharp.Formatting.Common.dll file
- - Fix bug in C# code formatting tool (FormatHtml)
-
-## 2.9.10 (27 June, 2015)
- - Support multiple snippets in Literate.Parse (This is obsolete, but needed for www.fssnip.net.)
-
-## 2.9.9 (22 June, 2015)
- - Fix HTML escaping of code blocks with unknown languages (#321, #322)
-
-## 2.9.6 (8 May, 2015)
- - Generate 'fssnip' class for non-F# 
 tags for consistency
-
-## 2.9.5 (6 May, 2015)
- - Provide an option to disable `fsi.AddPrinter` (#311)
- - Generated line numbers for HTML are the same for F# and non-F#
-
-## 2.9.4 (30 April, 2015)
- - Use `otherFlags` parameter (#308)
- - Format code in Markdown comments (#307, #36)
-
-## 2.9.3 (29 April, 2015)
- - Simplify using FCS interaction using Yaaf.Scripting (#305)
- - Do not load dependencies when initializing evaluator
- - Undo require exact version of F# Compiler Service
-
-## 2.9.2 (24 April, 2015)
- - Require exact version of F# Compiler Service
-
-## 2.9.1 (21 April, 2015)
- - Add back RazorEngine.dll (#302)
-
-## 2.9.0 (20 April, 2015)
- - Properly encode '>' entities (#84)
- - Generate line numbers for non-F# code (#227)
- - Support headings on the same line as comment (#147)
- - Fixes in HTML encoding of non-F# code snippets (#249, #213)
- - Remove Razor mono workaround (#279)
- - Add a public API to process a customized LiterateDocument (#282)
- - Add an API to process a customized LiterateDocument (#289)
- - Use template path if it is rooted (#281)
- - Enable evaluation tests for literate scripts
- - Create `fsi` object without `FSharp.Compiler.Interactive.Settings.dll`
- - Fix #229 (Key already exists exception when parsing an assembly)
- - Update to Visual Studio 2013 (only)
- - Update LaTeX colors using CSS Light theme (#278)
-
-## 2.8.0 (and before 20 April, 2015)
-* 1.0.15 - Added latex support, tables and better formatting with line numbers
-* 2.0.0 - New project structure, adding MetadataFormat
-* 2.0.1 - Fixed handling of # in headers
-* 2.0.2 - Change tool tip font for better readability
-* 2.0.3 - Fixed Markdown escaping, nested modules and types in FsHtmlDoc
-* 2.0.4 - Support escaping in inline code
-* 2.1.0-beta - Metadata and literate formatting now support Razor, include templates in NuGet package
-* 2.1.1-beta - Fix logo in nuget package
-* 2.1.2-beta - Fix nuget package
-* 2.1.3-beta - Fix the Root property for templating
-* 2.1.4 - Includes templates, support Razor for literate templates, bugs fixed
-* 2.1.5 - Improve default templates for open-source projects
-* 2.1.6 - Improve default templates for open-source projects (again)
-* 2.2.0 - Refactor literate tools
-* 2.2.1 - Remove (now unused) error handler parameter in literate (use ParseScript instead)
-* 2.2.2 - Nicer CSS style for API reference docs
-* 2.2.3 - Better recognition of links
-* 2.2.4-beta - Experimental - get snippet from file, some evaluation stuff
-* 2.2.5-beta - Add formatting for non-fsharp code, remove indents when importing snippet
-* 2.2.6-beta - Add page-source parameter for Razor tempalting
-* 2.2.7-beta - Generate docs for some F# types, formatting improvements
-* 2.2.8-beta - Add inline Latex support (thanks to Xiang Zhang!)
-* 2.2.9-beta - Update templates, support multiple DLLs in metadata format
-* 2.2.10-beta - Avoid locking assembly files in AssemblyResolve event
-* 2.2.11-beta - Generate links to source code, change default font, move styles to styles folder in package
-* 2.2.12-beta - Better compatibility for the default font style
-* 2.3.1-beta - Using new compiler services API, improved docs
-* 2.3.2-beta - Update to FSharp.Compiler.Service v0.0.10
-* 2.3.3-beta - Update FSharp.Compiler.Service and add fsdocs-tool package
-* 2.3.4-beta - Fix dependency in NuGet package
-* 2.3.5-beta - Omit non-public members from metadata docs by default
-* 2.3.6-beta - Update documentation, fixes for Mono compatibility
-* 2.3.7-beta - Add auto-formatting for links and output sample usage for DU cases
-* 2.3.8-beta - Update FSharp.Compiler.Service to v0.0.17
-* 2.3.9-beta - Update FSharp.Compiler.Service to v0.0.20, include inherited members when the base type was ommited from the documentation, fix properties displaying as methods, fix functions with unit input rendering incorrectly
-* 2.3.10-beta - Support output embedding in literate scripts
-* 2.3.11-beta - Support output embedding in command line tool
-* 2.4.0 - Incrementing version and stop using the beta versioning
-* 2.4.1 - Support for generating docs for type providers
-* 2.4.2 - Improved static parameter support, evaluation and math mode, support XML docs
-* 2.4.3 - Fix documentation, nicer github source links template
-* 2.4.4 - Live referesh in command line
-* 2.4.5 - Include tool tips when generating HTML using WriteHtml
-* 2.4.6 - Use --quiet (by default) to avoid calling default printer
-* 2.4.7 - Report errors from FsiEvaluator and stylesheet tweaks
-* 2.4.8 - Support do-not-eval and expose StdErr from eval failed event
-* 2.4.9 - Improve LaTeX formatting and make evaluator customizable
-* 2.4.10 - Automatically wrap LaTeX code in math mode blocks
-* 2.4.11 - Improved handling of end comments and http/https links at end of lines
-* 2.4.12 - Be more flexible about URL generating, protect against exceptions, fix bugs and typos
-* 2.4.13 - Fix evaluation bug; Return characters for horizontal lines
-* 2.4.14 - Update NuGet dependencies
-* 2.4.15 - Support combination of commands (e.g. hide, define-output), add do-not-eval-file
-* 2.4.16 - Improve formatting of literate scripts (generate tables around pre)
-* 2.4.17 - Fix comment parsing when whitespace
-* 2.4.18 - Expose literate paragraph transformation
-* 2.4.19 - Update command line tool to .NET 4
-* 2.4.20 - Add operator formatting to JavaScript langauge
-* 2.4.21 - Update to the most recent F# Compiler Service
-* 2.4.22 - Require specific versions in NuGet dependencies
-* 2.4.23 - Support generation of anchors in HTML documents
-* 2.4.24 - Include stylesheet for anchors & enable this for F# Formatting docs
-* 2.4.25 - Version with fixed dependencies, released using Paket!
-* 2.4.25 - Use Razor caching to drastically improve performance.
-* 2.4.26 - Proper release after nuget incident.
-* 2.4.27 - Better mono support and new logo.
-* 2.4.28 - Fix dependencies
-* 2.4.29 - Revert
-* 2.4.30 - Fsharp.Formatting MetadataFormat no longer crashes on C# dlls
-* 2.4.31 - Basic cache for RazorRender instances in FSharp.Formatting.Literate
-* 2.4.32 - Fixed regressions introduced by latest FCS
-* 2.4.33 - Fix cache using incomplete key
-* 2.4.34 - Better C# support / Don't depend on broken FCS
-* 2.4.36 - Better mono support
-* 2.4.37 - Fixed XML file resolution, support "cref", improve XML comment parsing, better logging and C# support
-* 2.5.0 - Update to latest FSharp.Compiler.Service
-* 2.5.1 - Fix handling of codeblocks inside and after lists
-* 2.6.0 - Bundle RazorEngine and System.Web.Razor to avoid dependency clashes
-* 2.6.1 - Support for Github flavoured markdown code blocks
-* 2.6.2 - Update to a new version of RazorEngine.
-* 2.6.3 - Better handling of F# snippets with invalid Unicode characters
-* 2.7.0 - Update to .NET 4.5 and use VS Power Tools for highlighting; Support categories on namespaces; Fix newlines
-* 2.7.1 - Colorize operators in the default template
-* 2.7.2 - Improve colours and ILRepack VS Power Tools (fix #261)
-* 2.7.3 - Revert ILRepack - fails on Mono (cc #261)
-* 2.7.4 - Add simple load script for easy referencing from FSX files
-* 2.7.5 - Update to net45 (fix #266 on windows), add search path to load script, fix EntityFramework bug (#270)
-* 2.8.0 - Redesgined file caching for Razor, documentation improvements, marking some thing internal
+## 2.12.1 - 2015-12-24
+* update dependencies
+* Upgrade the CommandTool to F# 4 and bundle FSharp.Core with sigdata and optdata.
+* Fix crash when a fenced code block starts with an empty line (https://github.com/fsprojects/FSharp.Formatting/pull/361)
+* Support for all known xml elements (https://github.com/fsprojects/FSharp.Formatting/pull/331)
+
+## 2.12.0 - 2015-10-18
+* Update dependencies to be compatible with FSharp.Compiler.Service >=1.4.0.3
+
+## 2.11.1-alpha1 - 2015-10-14
+* Adds methods for cross-type links #330 (https://github.com/fsprojects/FSharp.Formatting/pull/330)
+
+## 2.11.0 - 2015-09-28
+* Fix https://github.com/fsprojects/FSharp.Formatting/issues/271
+* Don't fail as long as we can recover / continue.
+* Fix https://github.com/fsprojects/FSharp.Formatting/issues/201
+
+## 2.10.3 - 2015-09-12
+* Require compatible F# Compiler Service in Nuspec (fix #337)
+
+## 2.10.2 - 2015-09-11
+* Fix load script (wrap logging setup in try catch properly)
+
+## 2.10.1 - 2015-09-11
+* paket update && fix compilation (#338)
+* Wrap logging setup in try catch
+
+## 2.10.0 - 2015-07-26
+* Add detailed logging and new FSharp.Formatting.Common.dll file
+* Fix bug in C# code formatting tool (FormatHtml)
+
+## 2.9.10 - 2015-06-27
+* Support multiple snippets in Literate.Parse (This is obsolete, but needed for www.fssnip.net.)
+
+## 2.9.9 - 2015-06-22
+* Fix HTML escaping of code blocks with unknown languages (#321, #322)
+
+## 2.9.6 - 2015-05-08
+* Generate 'fssnip' class for non-F# 
 tags for consistency
+
+## 2.9.5 - 2015-05-06
+* Provide an option to disable `fsi.AddPrinter` (#311)
+* Generated line numbers for HTML are the same for F# and non-F#
+
+## 2.9.4 - 2015-04-30
+* Use `otherFlags` parameter (#308)
+* Format code in Markdown comments (#307, #36)
+
+## 2.9.3 - 2015-04-28
+* Simplify using FCS interaction using Yaaf.Scripting (#305)
+* Do not load dependencies when initializing evaluator
+* Undo require exact version of F# Compiler Service
+
+## 2.9.2 - 2015-04-24
+* Require exact version of F# Compiler Service
+
+## 2.9.1 - 2015-04-21
+* Add back RazorEngine.dll (#302)
+
+## 2.9.0 - 2015-04-20
+* Properly encode '>' entities (#84)
+* Generate line numbers for non-F# code (#227)
+* Support headings on the same line as comment (#147)
+* Fixes in HTML encoding of non-F# code snippets (#249, #213)
+* Remove Razor mono workaround (#279)
+* Add a public API to process a customized LiterateDocument (#282)
+* Add an API to process a customized LiterateDocument (#289)
+* Use template path if it is rooted (#281)
+* Enable evaluation tests for literate scripts
+* Create `fsi` object without `FSharp.Compiler.Interactive.Settings.dll`
+* Fix #229 (Key already exists exception when parsing an assembly)
+* Update to Visual Studio 2013 (only)
+* Update LaTeX colors using CSS Light theme (#278)
diff --git a/build.fsx b/build.fsx
index 747b352c7..91b9daff3 100644
--- a/build.fsx
+++ b/build.fsx
@@ -1,13 +1,13 @@
 #r "nuget: Fun.Build, 0.3.8"
-#r "nuget: Fake.Core.ReleaseNotes, 6.0.0"
-#r "nuget: Fake.DotNet.AssemblyInfoFile, 6.0.0"
+#r "nuget: Fake.IO.FileSystem, 6.0.0"
+#r "nuget: Ionide.KeepAChangelog, 0.1.8"
 
-open System.Xml.Linq
-open Fake.Core
-open Fake.DotNet
+open System.IO
 open Fake.IO.Globbing.Operators
 open Fake.IO.FileSystemOperators
 open Fake.IO
+open Ionide.KeepAChangelog
+open Ionide.KeepAChangelog.Domain
 open Fun.Build
 
 let root = __SOURCE_DIRECTORY__
@@ -29,7 +29,13 @@ let artifactsDir = root @@ "artifacts"
 let fsdocTool = artifactsDir @@ "fsdocs"
 
 // Read release notes document
-let release = ReleaseNotes.load "RELEASE_NOTES.md"
+let releaseNugetVersion, _, _ =
+    let changeLog = FileInfo(__SOURCE_DIRECTORY__  "RELEASE_NOTES.md")
+
+    match Parser.parseChangeLog changeLog with
+    | Error(msg, error) -> failwithf "%s msg\n%A" msg error
+    | Ok result -> result.Releases |> List.head
+
 let solutionFile = "FSharp.Formatting.sln"
 
 pipeline "CI" {
@@ -38,33 +44,6 @@ pipeline "CI" {
         run $"dotnet fantomas {__SOURCE_FILE__} src tests docs --check"
     }
 
-    stage "AssemblyInfo" {
-        // Generate assembly info files with the right version & up-to-date information
-        run (fun _ ->
-            let info =
-                [ AssemblyInfo.Product project
-                  AssemblyInfo.Description summary
-                  AssemblyInfo.Version release.AssemblyVersion
-                  AssemblyInfo.FileVersion release.AssemblyVersion
-                  AssemblyInfo.InformationalVersion release.NugetVersion
-                  AssemblyInfo.Copyright license ]
-
-            AssemblyInfoFile.createFSharp "src/Common/AssemblyInfo.fs" info
-            AssemblyInfoFile.createCSharp "src/Common/AssemblyInfo.cs" info
-
-            let versionProps =
-                XElement(
-                    XName.Get "Project",
-                    XElement(
-                        XName.Get "PropertyGroup",
-                        XElement(XName.Get "Version", release.NugetVersion),
-                        XElement(XName.Get "PackageReleaseNotes", String.toLines release.Notes)
-                    )
-                )
-
-            versionProps.Save("version.props"))
-    }
-
     stage "Clean" {
         run (fun _ ->
             !!artifactsDir ++ "temp" |> Shell.cleanDirs
@@ -91,7 +70,7 @@ pipeline "CI" {
         // Τhe tool has been uninstalled when the
         // artifacts folder was removed in the Clean stage.
         run
-            $"dotnet tool install --no-cache --version %s{release.NugetVersion} --add-source \"%s{artifactsDir}\" --tool-path \"%s{artifactsDir}\" fsdocs-tool"
+            $"dotnet tool install --no-cache --version %A{releaseNugetVersion} --add-source \"%s{artifactsDir}\" --tool-path \"%s{artifactsDir}\" fsdocs-tool"
 
         run $"\"{fsdocTool}\" build --strict --clean --properties Configuration=Release"
         run $"dotnet tool uninstall fsdocs-tool --tool-path \"%s{artifactsDir}\""
diff --git a/docs/_template.html b/docs/_template.html
index 3baf0ece5..6348cc146 100644
--- a/docs/_template.html
+++ b/docs/_template.html
@@ -1,83 +1,89 @@
 
-
-
+
 
-    
-    {{fsdocs-page-title}}
-    
-    
-
-    
-    
-    
-
-    
-
-    
-    
-    
-    
-    
-    
-    
-    
-    
-    
+    
+    
+    
+    
+    {{fsdocs-page-title}} | {{fsdocs-collection-name}}
+    
+    
+    
+    
+    
+    
+    
+    {{fsdocs-head-extra}}
     {{fsdocs-watch-script}}
 
-
-
-    
-    
- -
-
- {{fsdocs-content}} - {{fsdocs-tooltips}} -
- - - - - - - - + + Header menu logo + {{fsdocs-collection-name}} + +
+
+ + + + + +
+ + +
+
+ {{fsdocs-content}} + {{fsdocs-tooltips}} +
+
+ + + +
+
    +

    Type something to start searching.

    +
    + + + + +{{fsdocs-body-extra}} - - - + \ No newline at end of file diff --git a/docs/commandline.md b/docs/commandline.md index 2b12df153..127a06dca 100644 --- a/docs/commandline.md +++ b/docs/commandline.md @@ -85,24 +85,22 @@ report an error (e.g. "Problem loading...", "Connection was reset"). ## Searchable docs -When using the command-line tool a Lunr search index is automatically generated in `index.json`. - -A search box is included in the default template. To add a search box -to your own `_template.html`, include `fsdocs-search.js`, which is added to the `content` -by default. - - [lang=text] - ... -