FSharp.Formatting

FSharp.Formatting copied to clipboard

Default code blocks render poorly on iOS/safari

3

 The 'pre' block inside the table seems to overflow incorrectly, as the screenshot shows.

adamchester

API reference for Property

2

It seems the API reference generated for "Property" is questionable. For example, look at the doc here: http://fsprojects.github.io/FSharpx.Collections/reference/fsharpx-collections-experimental-timeseries-1.html, pay attention to "StartDate", which is a property with a getter and...

zealisland

[WIP] Experiment with porting generation to signature like API

11

**Please do not merge as more work is needed before merging into main** This PR experiment with how we could use signature to document the API like proposed in https://github.com/fsprojects/FSharp.Formatting/issues/929....

MangelMaxime

Use signature-like for documenting the API

7

I propose to revisit the documentation to use "signature-like" to describe the API documentation. This is also to makes the most out of the XML doc comment. Here is a...

MangelMaxime

Replace `ApiDocMemberDetails` union with a record

2

`ApiDocMemberDetails` is currently described as a single case DUs. https://github.com/fsprojects/FSharp.Formatting/blob/2efb355823b8311f91a06566c0a3de86037a590d/src/FSharp.Formatting.ApiDocs/GenerateModel.fs#L292-L301 This makes accessing the information in it not easy because tuples doesn't expose a named property to accessing the different...

MangelMaxime

Use `Ctrl+C` instead of allowing any key press to kill the process

6

Using `Ctrl+C` is the standard to kill a CLI application. Would you be ok with using that instead of allowing any key press to kill it? My reason is that...

MangelMaxime

Making a change to `content/fsdocs-default.css` cause an infinite update loop

1

I am using ```bash dotnet build ../../fsprojects/FSharp.Formatting && /fsdocs-tool/bin/Debug/net6.0/fsdocs watch --nolaunch ``` to run the tool locally. However, when updating `fsdocs-default.css` (either in the F# Formatting repository or a copy...

MangelMaxime

Include images in documentation in generated content

17

Hello, I have been trying to include visual content in library documentation. My use case is that I am working on a project that interfaces heavily with CAD workflows. So,...

tymokvo

Remove root parameter override in watch mode

9

## Summary - Add optional `watch` flag for injecting a URL root into static site content for non-`localhost` browsers - Add case in `if watch` to replace root override with...

tymokvo

Enable `watch` server from arbitrary host

4

While working on a project with a new developer in a GitHub Codespace today, I wanted to be able to serve the documentation of our feature branch. However, I ran...

tymokvo