- Update FCS to 43.8.301. #935
- Shrink API docs example heading font size a bit. #923
- Improve overall API doc content alignment consistency in various scenarios. #923
- Add expand/collapse-all button for API doc details. #920
- HTML structure of generated API documentation. #919
- Details improvements. #917
Stable release
- Avoid theme flicker in dark mode. #901
- Marking development of v20 as complete.
- Use dvh for full viewport height . #899
- Add -webkit-text-size-adjust. #889
- Set default font-size for code. #889
- Use empty replacement for
{{fsdocs-meta-tags}
in API doc pages. #892
- Namespace description overflows content box. #886
- SEO-optimization for new theme. Allow
description
andkeywords
in frontmatter. Introduce{{fsdocs-meta-tags}}
. #869
- Added the ability to use ipynb files as inputs #874
- Fsx outputs no longer treat inline html as F# code. Inline html blocks are now enclosed inside literate comments.
- Add more options to customize colors.
--fsdocs-theme-toggle-light-color
and--fsdocs-theme-toggle-dark-color
are now deprecated. Use--header-link-color
instead.<FsDocsCollectionNameLink>
- Update FCS to 43.8.100
- Add more options to customize colors.
- Take
<UseArtifactsOutput>
into account during the project restore check.
- 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.
- Allow for more fine-grained styling control.
- Return original prop when no Directory.Build.props is used as fallback.
- Add dynamic
max-width
to tooltip. - Overflow long namespace names in overview table.
- Smaller scrollbars on mobile devices
- Use property values from the current
Directory.Build.props
file as fallback. #865
- Revisited search using fusejs
- Improve API doc styling.
- Make mobile menu scrollable.
- 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.
- default template style changes (
#fsdocs-page-menu
outsidemain
, link around project name, overflow ellipsis for menu items)
{{root}}
is now available as substitution in_body.html
and_head.html
.
FsDocsNavbarPosition
is no longer respected. Use CSS variables instead. See docs.⚠️ Search was completely removed and will be revisited in future versions.
- The default template was updated and is not compatible with previous versions.
- Dark mode is available out of the box.
{{fsdocs-head-extra}}
can included additional html before the closing</head>
when_head.html
exists.{{fsdocs-body-extra}}
can included additional html before the closing</body>
when_body.html
exists.- MSBuild property
<FsDocsFaviconSource>
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
tillh4
) of the current page. (if available)
- Fix code rendering on firefox. #851
- Update FCS to 43.7.400
- Pass
--multiemit-
as default option forFsiEvaluator
.
- Collapsible ApiDocs member info #778. The issue was fixed collaboratively in an Amplifying F# session with a recording that can be found here.
- Update FCS to 43.7.200
- Target
net6.0
forfsdocs-tool
#799
- Update ipynb output metadata #809
- One FSI evaluator per docs file #737
- Better test project detection #800
- Fix external docs link #794
- Improvement for
<seealso/>
#789
- Fix support for
<exclude/>
#786
- Resolve markdown links in raw html #769
- Update to .NET 7.0.100
- Update to .NET 6.0.400
- Update to Ionide.ProjInfo 0.60
- Custom templating for menus
- Fixes Markdown parser gets multiple-underscores-inside-italics wrong #389
- Trim the
--fscoptions
before passing them asotherflags
. (comment #616)
- fix #749
- Update to .NET 6
- Fixes 703, 700 -
--strict
is now considerably stricter, and more diagnostics being shown
- Skip the output folder when processing
- Remove unused TransformAndOutputDocument from API
- Fixes Can't yet format InlineHtmlBlock #723
- Fixes
<code>
blocks are emitting<pre>
blocks with escapes no longer escaped #712
- Remove front-matter output from notebooks
- Improve package description
- Style blockquotes
- Bump to FSharp.Compiler.Service 40.0
- Fix bottom margin in default CSS
- Improve github and signature links
- Fix typo in location for custom CSS
- scrollable navbar #677 by nhirschey
- Show field type for record fields #674
- Add --ignoreprojects flag #676 by chengh42
- Add frontmatter, category, categoryindex, index, title
- testing package publish
- testing package publish
- add favicon.ico to template and use F# logo as default favicon for generated sites
- update to Ionide.ProjInfo
- use computed args for references in API doc generation
- Fix #616
- Fix #662
- Fix #646
- Switch to cleaner default styling based on DiffSharp styles
- Change
fsdocs-menu
tofsdocs-nav
- Add cref copy buttons by default
- Fix more formatting and switch to
fsdocs-member-usage
instead offsdocs-member-name
- Permit
cref:T:System.Console
code references in markdown content
- Apply substitutions to content
- Add
fsdocs-source-filename
andfsdocs-source-basename
substitutions
- Trim spaces from examples (TrimEnd only)
- Trim spaces from examples
- Proper fix for elide multi-language docs from navigation and site search index
- Rename --property flag to --properties
- Elide multi-language docs from navigation and site search index
- update FCS, allow fsdocs to roll forward to net5.0
- Refactor the templating engine and the command tool cache
- Refactor the project cracker
- Retry project cracking when there isn't a targetPath
- Add include-it-raw literate command
- Add more complete info on how to upgrade
- CommandTool: add hot reload to the watch command
- 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
-
Comma-separate interface list in API docs
-
Remove untyped Sections from ApiDocComment since individual supported sections are now available
-
ApiDocs: cref to members are not resolving to best possible link
-
ApiDocs: namespace docs are showing in module/type summaries as well
-
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
-
change
<namespacesummary>...<namespacesummary>
to<namespacedoc> <summary>... </summary> </namespacedoc>
-
change
<categoryindex>3<categoryindex>
to<category index="3">...</category>
-
support
<namespacesummary>...<namespacesummary>
-
support
<namespaceremarks>...<namespaceremarks>
-
support
<note>...<note>
-
support
<category>...</category>
-
support
<exclude />
-
allow
<a href="..." >
in XML doc comments -
allow
<paramref name="..." >
in XML doc comments -
document XML doc things supported
- instruct about settings
- fix images in nuget
- include templates
- bump version
- bump version
- fix navbar position option fixed-left
- fixed property computation
-
fixed typo for
LICENCE.md
-
all classes to have
fsdocs-
prefix
-
fixed all classes to have
fsdocs-
prefix -
added documentation on styling
- fixed root
-
add text content of markdown and scripts to generated search index
-
overhaul the substitution names used by FSharp.Formatting and expected in the template. The table is in the docs and below
-
generate {{fsdocs-list-of-documents}} substitution and use it in both API docs and content
-
generate {{fsdocs-list-of-namespaces}} substitution and use it in both API docs and content
-
fix link model so {{root}} is always respected
-
Add
qualify
parameter that asks to qualify all names by the collection name e.g. FSharp.Core -
Respect per-project settings, e.g. if one nuget package has a different set of authors or home page to another
-
Add documentation about styling
-
Allow fixed-left and fixed-right positions for the navbar
-
Add
{{fsdocs-logo-link}}
parameter to default template -
Add
{{fsdocs-logo-link}}
parameter to default template -
generate HTML giving hyperlinks for types with cross-links
-
switch to left bootstrap nav bar in template for a table of contents
-
improve sizings
-
move to one copy of template in docs/_template.html
-
ApiDocsTypeDefinition and ApiDocsModule merged to ApiDocsEntity
-
Default template now expects logo in img/logo.png
-
Improvements in default HTML generation
-
ApiDocComment.Blurb renamed to ApiDocComment.Summary and only populated with summary text for things read from XML
-
simplify tool instructions
-
add info about upgrading
- fix mistake in laying down
extras
directory
- put extra content in
extras
directory in nuget package and include Dockerfile and NuGet.config
- 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
- fix formatting of generic parameters so they don't show inference variables for members
- fix default styling
- improve display in FSharp.Formatting API docs and add more information
- Watch defaults to
tmp/watch
- 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
- Remove the
api
command from the command line tool (build
generalises it) - Add missing search.js
- build the Lunr
index.json
from every execution offsdocs 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 inApiDocsModel
- Remove
Details
fromApiDocsModel
- Correct behaviour of '--clean'
- Fix emit of odd character in latex output
- Paket update and remove workaround code
- add '--clean' to fsdocs
- 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.
- Support preview F# language features.
- Add support for customizing assigned CSS class.
- Add .NET Core support for all libraries.
- Update to FSCS v35.0.
- Add helpers for CustomOperationAttribute.
- Update to FSCS v34.1.
- Update to FSCS v34.
- Fix packaging issues.
- Add .NET Core support for all libraries.
- Update to latest FSharp.Compiler.Service
- remove beta tag since it is already widely used
- Update to latest FSharp.Compiler.Service
- No longer filter FSHarp.Core based on optdata/sigdata (it is now always bundled)
- FSharp.Formatting.Literate for netstandard2.0
- Fix usage formatting - #472
- Added support for attributes on modules, types and members
- Updated razor templates to show attributes and added a warning for obsolete API
- Upgrade FSharp.Compiler.Service to be compatible with FAKE 5
- Fix some links on the website - #458
- Another link on the website - #454
- Support highlighting for paket.dependencies
storage
keyword - #451 - In order to upgrade follow instructions at https://fsprojects.github.io/FSharp.Formatting/upgrade_from_v2_to_v3.html
- Improve Stacktrace on Script file processing
- Fix System.ValueType dep.
- Include razor component.
- Always generate anchors when using command line tool.
- Don't hide errors in fsformatting tool (Literate).
- Improve error message by using inner exceptions.
- Don't hide errors in fsformatting tool.
- MarkdownSpan and MarkdownParagraph now use named DUs
- Add range to MarkdownParagraph and MarkdownSpan (#411)
- FSharp.Formatting no longer has a strong dependency on Razor (#425)
- FSharp.Formatting no longer depends on VFPT.Core (#432)
- Add beta packages to AppVeyor feed.
- Update FSharp.Compiler.Service component.
- Use
#I __SOURCE_DIRECTORY__
in the loads script (more reliable)
- 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)
- Add code to parse table rows correctly (#394)
- Also fixes (#388) Markdown parser doesn't recognize inline code
x | y
inside table cell
- Temporarily pin FSharp.Compiler.Service (#395)
- Cache is new keyword in Paket (#392)
- Added TypeScript to the CSharpFormat project (#386)
- Fixes issues in PaketFormat (#381) - colorize HTTP and file prefix
- Reliable getTypeLink (#380) - avoid crashes
- Colors paket keywords (#379)
- Adds PaketFormat to not color URLs as comments in Paket files (#349)
- Improve the load script to fix FsLab issue (https://github.com/fslaborg/FsLab/issues/98)
- Make logging to file optional using environment variable
- Be compatible with the common-mark spec for 'Fenced code blocks' and 'Indented code blocks'. See #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 (#372)
- 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 (#361)
- Support for all known xml elements (#331)
- Update dependencies to be compatible with FSharp.Compiler.Service >=1.4.0.3
- Adds methods for cross-type links #330 (#330)
- Require compatible F# Compiler Service in Nuspec (fix #337)
- Fix load script (wrap logging setup in try catch properly)
- paket update && fix compilation (#338)
- Wrap logging setup in try catch
- Add detailed logging and new FSharp.Formatting.Common.dll file
- Fix bug in C# code formatting tool (FormatHtml)
- Support multiple snippets in Literate.Parse (This is obsolete, but needed for www.fssnip.net.)
- Fix HTML escaping of code blocks with unknown languages (#321, #322)
- Generate 'fssnip' class for non-F#
tags for consistency
- Provide an option to disable
fsi.AddPrinter
(#311) - Generated line numbers for HTML are the same for F# and non-F#
- Use
otherFlags
parameter (#308) - Format code in Markdown comments (#307, #36)
- Simplify using FCS interaction using Yaaf.Scripting (#305)
- Do not load dependencies when initializing evaluator
- Undo require exact version of F# Compiler Service
- Require exact version of F# Compiler Service
- Add back RazorEngine.dll (#302)
- 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 withoutFSharp.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)