fsprojects / FSharp.Formatting

F# tools for generating documentation (Markdown processor and F# code formatter)
https://fsprojects.github.io/FSharp.Formatting/
Other
462 stars 155 forks source link

Add how-to for the most typical scenario #853

Closed nojaf closed 5 months ago

nojaf commented 8 months ago

We should add a short guide on how to set up the most common scenario for people to use this tool. We could benefit from a step-by-step guide on how to go from a first Markdown file in the docs folder to a published GitHub pages website.

Something along the lines of:

I think this could encourage more projects to add documentation.

SchlenkR commented 8 months ago

See here for a demo repo (PRs welcome):

https://github.com/RonaldSchlenker/FSDocsDemo

nojaf commented 5 months ago

This guide covers this: https://fsprojects.github.io/FSharp.Formatting/zero-to-hero.html