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

Suggestion: init command #872

Open kMutagene opened 7 months ago

kMutagene commented 7 months ago

I have grown the habit of copy-pasting and adjusting my go-to folder structure and _template.html file whenever i create docs for a new project.

However, i can understand new users being confused by the actual setup process, as you have to create a folder structure with multiple files by hand. I think it is reasonable for a tool such as fsdocs to provide a single command that initializes the necessary folder structure for the documentation folder.

For this, i suggest the addition of a fsdocs init command, which could have flags for also adding other templates, e.g., _template.ipynb, as well as svg files for download notebook or download script links (see for example here on the top of the page)

This could also be used for some automated SEO tags, see #869 (there is a default template, which should be adjusted and created by this init command)