Here are the typical steps to upgrade a repo based on ProjectScaffold
to use fsdocs
Run
|
Delete all of docs\tools
particularly docs\tool\generate.fsx
. Keep a copy of any templates for reference as you'll have to copy some bits across to the new template.
Put your docs directory so it reflects the final shape of the site. For example move the content of docs\input\*
and docs\files\*
directly to docs\*
Follow the notes in styling to start to style your site.
Run
|
and edit and test your docs.
If using FAKE adjust build.fsx
e.g.
|
Consider creating docs\_template.fsx
and docs\_template.ipynb
to enable co-generation of F# scripts and F# notebooks.
If you add support for notebooks and scripts, consider adding mybinder links to each of your literate executable content pages. For example like this.
Also add load sections to make sure your notebooks and scripts contain the right content to load packages out of repo. For example like this.
Sample commands:
|
Here is an example PR: https://github.com/fsprojects/FSharp.Control.AsyncSeq/pull/116