Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Distinguish C# and F# code in documentation #439

Open
hickford opened this issue May 25, 2018 · 7 comments
Open

Distinguish C# and F# code in documentation #439

hickford opened this issue May 25, 2018 · 7 comments

Comments

@hickford
Copy link
Contributor

hickford commented May 25, 2018

An idea: it could be helpful to distinguish C# code from F# code in the documentation somehow, eg. by giving it a different background colour. This would make the documentation easier to read. I know both F# and C# but still find it confusing reading one when expecting another.

Example https://fscheck.github.io/FsCheck/Properties.html

@kurtschelfthout
Copy link
Member

Yes, this is a good idea. Do you know how to do it? We use Fsharp.formatting. Perhaps there is some css magic we can do?

@jzabroski
Copy link

jzabroski commented Jun 26, 2018 via email

@hickford hickford changed the title Distinguish C# and F# code in documentation by background colour Distinguish C# and F# code in documentation Jul 20, 2018
@Angr1st
Copy link

Angr1st commented Feb 18, 2019

I would like to tackle this.

@kurtschelfthout
Copy link
Member

Nice! Do you need some pointers - I can only be of minimal help - I would start with digging through the generated html etc and figure out if there is some css we can leverage.

FSharp.formatting does allow us to specify a template so maybe it’s possible to put something there.

@Angr1st
Copy link

Angr1st commented Feb 19, 2019

I have already skimmed through the code and tried to find out how to alter the css to adapt the background color. It currently seems like we just use the default css that is delivered by Fsharp.Formatting. I have opened an issue with them for this as a feature as I think that there would be more people that would enjoy some clearer language snippet differentiation.

@kurtschelfthout
Copy link
Member

That's awesome.

I noticed that the snippets are surrounded by <code lang="fsharp"></code> tags - any chance we can do something with that?

Sorry if that's stupid or obvious, I know next to nothing about css etc :)

@Angr1st
Copy link

Angr1st commented Feb 21, 2019

No worries my css knowledge is not that big but in theory we could but it would need to be done in fsharp.formatting itself.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants