fsharp / fsharp-core-docs

Generated API documentation for the FSharp.Core library. Generated using FSharp.Formatting.
http://fsharp.github.io/fsharp-core-docs
MIT License
34 stars 19 forks source link

Improve default styling and top-level content layout #34

Open dsyme opened 4 years ago

dsyme commented 4 years ago

As noted by @baronfel in #27, the default styling and top-level layout needs improvement.

What is here is the current default styling for FSharp.Formatting using the standard _template.html, which is tight for iteration but we can do better. If necessary we can add a _template.html or fsdocs-styles.css in here though to be honest I'd love it if we could make the default FSharp.Formatting _template.html good enough to be both configurable for the needs of this repo and to satisfy and please.

Please make a note below everything that you do/don't like about the current design, layout and content. If possible give specific (preferably visual) examples of what you want improved, and, if possible, give links to how those improvements might be made in terms of CSS improvements and JS framework changes.

The things I've noticed so far:

dsyme commented 4 years ago

@cartermp @Krzysztof-Cieslak @baronfel

I copied over the default templates and styling and you guys can hack away on the design, fonts, JS frameworks used and so on to your heart's content.

Once you're done we can copy the results back into FSF as a default template

You may need to improve the style tagging in the generated HTML. I'd like FSF to document the style tags emitted and make sure we don't change them too much

dsyme commented 4 years ago

I've also added a front page which I think greatly helps the site, though it all needs good styling